0% found this document useful (0 votes)
3K views783 pages

3DEXPERIENCE Platform Installation Fundamentals R2023x V1.4

Uploaded by

kiran babu
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
3K views783 pages

3DEXPERIENCE Platform Installation Fundamentals R2023x V1.4

Uploaded by

kiran babu
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 783

© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.

: 3DS_Document_2020

On Windows
3DEXPERIENCE platform Installation Fundamentals
1
Disclaimer

The content of this training material has been created with great care. Dassault Systèmes takes no responsibility for the topicality, correctness,
completeness or quality of the data and information. Liability claims against Dassault Systèmes, which refer to material or immaterial nature caused by
use or disuse of the data and information provided through the use of incorrect and incomplete data and information are basically excluded.

Dassault Systèmes reserves the right to change parts of this training material and information, or the entire offer without prior notice, add to, delete or
cease publication temporarily or permanently.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

All data and information are offered free and without obligation.

2
Caution/Warning

This document is based on a various internal DS content for 3DEXPERIENCE platform R2023x.

In some cases, this document may contain forward looking statements based on current expectations, forecasts and assumptions that involve risks and
uncertainties.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Upon further communication this document is classified to be DS Confidential. It should not be distributed without DS authorization.

3
About this course

Course objectives
Familiarize with the 3DEXPERIENCE platform architecture
Configure the middleware pre-requisites like Apache, TomEE+ and SSL
Configure either Oracle or SQL Server database
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Install the components of the 3DEXPERIENCE platform


Integrate the platform with native apps (CATIA) and Microsoft Office
Validate functional scenarios ensuring successful installation of platform components

Target audience
Infrastructure Architect, Infrastructure Consultant, Software Consultant

Prerequisites, knowledge about:


Operating System (Windows) installation and configuration
Database installation and configuration
Networking concepts

Participants attending this class must have gone through the 3DEXPERIENCE platform Architecture Overview course.

40 Hours

4
Glossary

Dassault Systèmes IT Related


DS / 3DS : Dassault Systèmes OS : Operating System
GA : General Availability DB : Database
HF : Hot Fix EE : Enterprise Edition
FP : Fix Pack GUI : Graphical User Interface
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

DSLS : DS License Server TUI : Text User Interface


SP : Service Pack (V5 or OS) UI : User Interface
OOTB : Out Of The Box FQDN : Fully Qualified Domain Name
UID : User Identification AD : Active Directory
Platform : The 3DEXPERIENCE Platform LDAP : Lightweight Directory Access Protocol
VM : Virtual Machine
IP : Internet Protocol
General LB : Load Balancing
LMB : Left Mouse Button HA : High Availability
RMB : Right Mouse Button DR : Disaster Recovery
CAS : Central Authentication Service
RDP : Remote Desktop Protocol
RPO : Recovery Point Objective
RTO : Recovery Time Objective
SME : Subject Matter Expert
TCL : Tool Command Language

5
Table of Contents

Introduction
Architecture overview
Installation preparation review and validation
Install and configure middleware
Java
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Apache
TomEE+
SSL
Database
Install and configure the core components of the 3DEXPERIENCE platform
3DPassport
3DDashboard
3DSearch
3DSpace
3DNotification
3DComment
3DSwym
FCS
Install 3D Indexing server
Install a Fix Pack (FP) for all installations
Install CSV App modules and preparation for integration with Native Apps
Install the 3DEXPERIENCE Native Apps
Validate the installation with functional test scenarios
6
Details: Training Environment

During the enrollment you will be in one of the two options below. Based on your option you may need to perform a checklist prior to attending the
training. This only applies to the client side applications, non conformity will result in not being able to complete the training, this is responsibility of the
trainee.

3DS provided Server VM and Trainee provide the client machines


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

By 3DS: the 3DEXPERIENCE platform server VM.


By the trainee: Optional if the trainee comes with their own client installation.
Access to a DSLS.
Native Apps Client Media
CATIAV5 Media
MS Office
3DS licenses and third party licensing conformity is the student’s responsibility.

7
Introduction to Training

You may have your own personal installation preferences and tools, but for this training it is recommended to perform the installation as instructed.
Later, if you choose, you may adapt these steps for your own specific needs.

These following components must be decided upon prior to beginning the 3DS software selection:
Operating system
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Database

These decisions will drive your prerequisites and validation steps as listed below:

Training Configuration

Windows Linux

SQL SQL
Oracle Oracle
Server Server

Pre-requisites

Validation

8
Course Flow

The course details the installation in a structured flow:

Theory: This section provides an overview about a particular topic.

Exercise: This section provides detailed instructions to perform the hands-on to install the 3DEXPERIENCE platform.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Appendix: This section covers topics that are optional for core installation. However, their know-how and installation enhances the
3DEXPERIENCE platform experience on the whole. This is at the end of the course.

Glossary: This section describes specific terms that aid in 3DEXPERIENCE platform installation.

9
Agenda

Monday Tuesday Wednesday Thursday Friday

Pre Training

-- WELCOME -- 3DPassport installation (GA)


3DNotification Installation (GA)
Introduction Reconfiguration
9:30 – 11:00 CSV Apps (FP) Functional validation check
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Architecture overview 3DDashboard installation (GA) 3DComment Installation (GA)


Hands-On- Check prerequisites 3DSearch installation (GA) EXALEAD CloudView Installation (GA)

Coffee break (11:00 – 11:15)

3DSpaceIndex installation (GA)


3DSpace Post Install (WAR +
Compilation)
3DSwym Installation (GA)
Hands-On Deploy middleware
11:15 - 1:00 Functional validation check
Java, Apache
3DSpace installation (GA) 3DNotification Installation (FP)

FCS Central Installation (GA) 3DComment Installation (FP)

Lunch (1:00 to 2:00)


EXALEAD CloudView
3D Indexing Server Installation (GA)
Hands-On Deploy TomEE+ Installation (FP)
for 3DEXPERIENCE platform
Diagnosing of 3DEXP Platform (GA) 3DSwym Installation (FP)
2:00 – 3:30 CSV Apps GA
3DPassport installation (FP) FCS Central Installation (FP)
Hands-On create and deploy SSL
Certificates 3D Indexing Server Installation
3DDashboard installation (FP)
(FP)
Coffee break (3:30 to 3:45) Q&A

3DSearch installation (FP)


Hands-On Create Database
CSV Apps GA (Continued)
Instance Native Apps and Client
3:45 – 5:00 3DSpaceIndex installation (FP)
Integration
3DSpace Post Install (WAR +
DSLS installation theory 3DSpace installation (FP)
Compilation)
Troubleshooting for Participants / Troubleshooting for Participants / Troubleshooting for Participants
5:00 – 5:30 Troubleshooting for Participants / Q&A
Q&A Q&A / Q&A

10
Conventions (1/2)

The following typographic conventions are used in this course:

Bold text within a sentence denotes the name of a tool, icon, window, dialog box, button or option.

Italic text within a sentence is used to denote the name of a tree item or a data file, or to apply emphasis on a key word.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Numerical lists are used in sequential lists, such as the steps of an exercise procedure.

Lower-case alphabetical sub-lists are typically used in the sub-steps of an exercise procedure.

Text enclosed in these <> brackets corresponds to the text that must be typed into the text field of a dialog box or prompt.

11
Conventions (2/2)

Courier New identifies the commands that are typed in the command prompt or file & paths.

Underline1 identifies the website address.

Underline2 identifies the text that is emphasized technically.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1 identifies the areas in an image that are


associated with the corresponding text in a sequential list or an exercise procedure.

Upper-case alphabetical lists are used for items that are non-sequential, such as options or definitions.

12
Lesson 1: Architecture Overview

Architecture overview topics:

On-Premises Architecture: Platform apps and Services


3DEXPERIENCE platform – n-Tier Web Logical Architecture
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DEXPERIENCE platform – R2023x GA Logical Architecture On Premise

1 hour

13
3DEXPERIENCE platform Services and Apps

3DComment 3DNotification 3DSpace, 6WTags & 3DCompass


Share your thoughts & POV.
DSLS
Deliver notifications from Manage and share data, documents, related
Engage in discussion with peers. platform as well as apps. Platform licensing
information. Personalized and role-based management server.
access to all apps.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DPassport 3DDashboard 3DSwym & video converter 3DSearch


Identity management Listen, track and govern Social collaboration through Intelligent search to re-use
and authentication across all flawlessly. communities. and re-purpose intellectual
apps. assets.

3DOrchestrate 3DGlobe
Distribute and parallelize the execution of Interact with a terrestrial
simulation process jobs and share the globe Manage
results Georeferenced objects

3DMessaging
Enterprise & Control Centers
Manage members, role-based access and usage
analytics. Configure app behavior to suit your
individual needs.

14
3DEXPERIENCE versus V6

V6 intended at leveraging product and project information collaboration. It aimed to work synchronously with ERP, SCM and CRM using technologies
like SOA, SaaS and Web 2.0. It is operated with cross functional and inter-company silos.

3DEXPERIENCE platform offers an intuitive interface to experience PLM with:


3DPassport for authentication.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DDashboard for creating widgets.


3DSpace for authorization and working with the 3D geometries across different industry verticals.
3DSwym, 3DComment, 3DNotification for collaboration and networking within communities.

3DEXPERIENCE platform provides improved installation experience.


Consistent installation on Linux and Windows with one installation script per service.
Support on Oracle / MS-SQL Server. Migration tool to switch to Oracle.
Offers three ways to execute installation: Interactive, Command and Silent.
Install multiple services faster on the same machine with one installer.

15
3DEXPERIENCE Architecture

Modularity: Is the degree to which a system's components may be separated and recombined.
Fail-over: In case of failure of an application server transaction is dispatched on another application server.
Load balancing: Ability to dispatch load on different Application servers or File servers. Managed DSLS
Presentation

Option A
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Web Server / Load balancer / Reverse proxy


(Public cloud)
HTTPS (FQDN) Front End 
Logic and Access

Active/Active Active/Active
Active/
Passive

Option B

3DNotification 3DPassport 3DDashboard 3DSearch 3DComment 3DSwym 3DSpace FCS DSLS

HTTP(s if desired)
------- Back End -------
TCP/IP & NFS
Active/Active
(Run time) (Run time)

D
Data

I I

3DSwym 3DSwym 3DIndex Database 3DSpace Index NAS / SAN


Media Converter Cloudview Index Server Metadata Repository Server
optional
16
3DEXPERIENCE Architecture – On Cloud

Multiple Companies
Company
Note: The
3DSOpen native apps
3DEXPERIENCE users are local to
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Native
Applications each
https://www workstation.

Dassault
Systèmes
Control Center SaaS DS Cloud
Software as a Service
Provider Data
On-Cloud

PaaS Center
Platform as a Service

Monit oring &


Operat ions done by
IaaS
Infrastructure as a Service
cert ified operat ors
(including provisioning,
maint enance and upgrade)
Public Cloud

17
3DEXPERIENCE platform R2023x Supported Architecture - On Premises

3DPassport 3DDashboard 3DSearch 3DComment 3DSpace 3DSwym 3DNotification DSLS

Load balancing Load Balancing 1) 2)


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Application
TomEE+ NodeJS
Servers

3D Index 3DSwym Media


Infrastructure Server Converter
Services and License Control
Indexing
3DSpace Index 3DSwym Index

3DSwym Media
File Storage 3DSpace FCS
Store

Metadata Oracle on RHEL, SUSE, Windows


Storage SQL Server on RHEL, SUSE, Windows

Operating
RHEL, SUSE, Windows, Oracle Linux, RedHat Compatible Kernel 7.x, with x > 4, Oracle Linux, RedHat Compatible Kernel 8.x, with x > 2
System(s)

1) 3DNotification is only Active-Passive, HA compliant but not load balanced.


2) DSLS is load balanced using the internal mechanism of three server cluster.

For details: http://www.3ds.com/support/documentation/program-directories

18
3DEXPERIENCE R2023x Strategic platform Prerequisites - On Premises (1/3)

Server Hardware & Software

Server
LINUX - 64bit Windows Server- 64bit

3DSpace / 3DDashboard / 3DSwym License 3DSpace / 3DDashboard / 3DSwym License


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Stack 3D Notification 3D Notification


3DComment / 3DPassport / 3DSearch Control 3DComment / 3DPassport / 3DSearch Control

Apps Server Apache TomEE+ 8.0.12 NodeJS Apache TomEE+ 8.0.12 NodeJS

Oracle DB 19c (including RAC) ORACLE EXADATA Not Oracle DB 19c (including RAC) Not
ORACLE EXADATA
Database Applicable Applicable
SQL Server 2017, 2019
SQL Server 2017, 2019
Language IBM Semeru Runtime Open Edition for Java 17.0.3 IBM Semeru Runtime Open Edition for Java 17.0.3
Operating Red Hat Enterprise Linux 7.5, RedHat Compatible Kernel 7.x, Oracle
Windows Server 2016 & 2019
Systems Linux, RedHat Compatible Kernel 8, SLES 12
Virtualization VMware ESXi 6.5, MS Hyper-V, KVM, XEN (DS License server is supported only in failover mode in Microsoft Hyper-V virtualized environments.)
Processor X86_64 (Intel, AMD)
Hardware Server Class

For details: https://media.3ds.com/support/progdir/623x/prerequisites/strategicplatforms_for_servers.html

19
3DEXPERIENCE R2023x Strategic platform Prerequisites - On Premises (2/3)

Browser Client Hardware & Software


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

20
3DEXPERIENCE R2023x Strategic platform Prerequisites - On Premises (3/3)

Native OS Client Hardware & Software Requirements

Native OS Client

Stack Windows - 64-bit


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Operating
Windows 10/Windows 11 + Office 2016, 2019 or 365
Systems

Java IBM Semeru Runtime Open Edition for Java 17.0.3

Native Apps Mandatory Pre requisite : Internet Explorer 11

Browser Firefox ESR 102, Chrome, Microsoft Edge Chromium

Processor X86_64 (Intel, AMD)

For details: https://media.3ds.com/support/progdir/623x/prerequisites/strategicplatforms_for_native_os_client.html

21
3DEXPERIENCE R2023x Strategic platform - Knowledge Base

3DS > Support > Knowledge Base – Search using keyword “Best Practices”

3DS best practices documents are publicly available on the 3DS web site, providing an excellent source of supplementary infor mation.
Make use of filters when searching for documents
Before communicating the existence of a document to a customer, pay attention to its “Visibility”
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

When searching for a best practice, use a few words from the document title or
filename but not the whole filename:
 Server Crash Hang and Memory Dump Collection and its Analysis
X DS_WhitePapers_Crash_Hang_and_Memory_Dump_Collection_and_Analysis

For details: https://support.3ds.com/knowledge-base/

22
Lesson 2: Setting Up Installation Infrastructure

During the enrollment you will be in one of the two situations below. Based on your option you may need to have perform a checklist in your laptop,
prior to arriving to the training. This applies to the client side only, non-conformity will result in not being able to complete the training, this is the
responsibility of the trainee.
You will be able to complete this at lunch time if needed
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DS provided Server VM and Trainee provide the client machines


By 3DS: the 3DEXPERIENCE platform server VM.
By the trainee: Optional if the trainee comes with their own client installation
Access to a DSLS.
Native Apps Client Media
CATIAV5 Media
MS Office

30 minutes

23
Installation Environment Users and Passwords

Password for this training:

OS Users
dsadmin: Zaq1@WsxCde3
dbadmin: Zaq1@WsxCde3
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

DB Users
MSSQL: Passport#1
Oracle: Same as Schema Name

DS Product
admin_platform : Zaq1@WsxCde3
Email : [email protected]
Exaleads : Zaq1@WsxCde3

24
Laptop & Server Checklist

Topics to be covered:

1. Laptop & Server Checklist


Checklist

Laptop: Validate against the checklists below.

Create a Remote Desktop Connection (RDP) icon on your desktop.


To the provided server IP for you
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Verify the connection is successful with dsadmin

Check the DSLicSrv.txt file in C:\ProgramData\DassaultSystemes\Licenses

Do you see the CATIA V5-6R2023 and MS Office icons on your Client desktop.

CATIA V5 should be installed, test that MD2 license is registered in the DSLS
<CV5 Installation>\win_b64\code\bin> DSCheckLS.exe -r MD2

26
Checklist

Server
Login to the 3DS-VM from your 3DS-Laptop with Remote Desktop (RDP) and verify the
following.
Do you see Computer , Network and Control Panel icon on dsadmin desktop.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

RMB on This PC icon, Click Open and check if the C, D and E drives are present.
C: drive holds OS, Database
D: drive, where you will install the Webserver, 3DEXPERIENCE platform
E: drive contains DS Media, that is, “your media path”.
(You may notice E: and E$ respectively referring to the drive, this is only dependent
on how you can mount the drive.)

27
Checklist

Server

Does the following directory structure exist under


D:\3DEXPERIENCE\TomEE
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

During installation you will deploy


different 3DEXPERIENCE services here.

Confirm that you have Apache code installed under


D:\Apache24 directory

28
Checklist

Server

Open a Windows command prompt, execute the following command and confirm the output
D:\3DEXPERIENCE\Java64\jdk17\bin\java -version
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

29
Checklist

Server
Confirm the Oracle installation created the highlighted Groups (you can use compmgmt.msc to launch the Computer Management window)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

30
Checklist

Server
Oracle
Select Control Panel > System and Security > Administrative Tools >Computer Management.
Expand Local Users and Groups > Users and right-click to launch Properties for dbadmin and dsadmin respectively.
Validate if the Member of tab for the following users is correct.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

31
Checklist

Client & Server

From the Server and the client, try telnet to the DSLS.

Get the list from your: C:\ProgramData\DassaultSystemes\licenses\DSLicSrv.txt


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Server:
telnet 4085
telnet 4085
telnet 4085

Client: If it’s your personal laptop this list need to be adapted


telnet DSLS001 4085
telnet DSLS002 4085
telnet DSLS003 4085

32
Checklist

Client & Server


Confirm/add your Internet Properties includes the URL: https://*.mytraining.com (you can use inetcpl.cpl to launch the Internet Options window)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

33
Checklist

Client & Server

Confirm/add your Internet Properties > Privacy > Pop-up Blocker Settings contains *.mytraining.com
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

34
Summary

Setting Up Installation Infrastructure

You have browsed the infrastructure required for the training:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Client : Your or provided laptop.


 Server : Access to the Server from your laptop.

35
Lesson 3: Middleware Configuration

Introduction

Operating System
Java Configuration
Apache Configuration
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

TomEE+ Configuration
Generation and Deployment of SSL certificates

1 hour

36
Overview

The 3DEXPERIENCE platform software is an Enterprise wide application, similar to:


An ERP system like PeopleSoft, billing systems, customer relationship and supplier relationship management systems.

This document will detail the preparation for all middleware configurations.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This chapter will allow to configure third party middleware before installing 3DEXPERIENCE platform products. To achieve these tasks, IT
Hardware and Software experiences are required.

These tasks are related to:


Java configuration
Apache configuration
TomEE+ configuration
SSL Certificate generation and deployment

37
Introduction

Topics to be covered:

1. Introduction
2. Java Configuration
3. Apache Configuration
4. TomEE+ Configuration
5. SSL Configuration
Introduction

You are going to perform the following middleware configuration on your 3DEXPERIENCE Server. This sequence ensures that all dependencies are
achieved and tested prior to the actual installation.

Java Configuration
Apache Configuration
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

TomEE+ Configuration Training Configuration


SSL Generation and Deployment of SSL certificates
Database Configuration
Database/instance creation
Windows Linux
Defining end points
Database/instance Configuration
Table space creation (if applies)
SQL Oracle SQL
User/schema creation Server
Oracle Server
User/schema permission

Pre-Requisites

Validation

39
All: Pre-check when using a VM

One last important fact about accessing “Your Media/Installers path”.

One of the basic recommendation is not to use "blank space" in folder or file name.

During VM build it’s very common not to copy the code locally in the VM and to simply network mount a drive where all “Your M edia/installers PATH”
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

are present, it’s important that this path has no spaces.

Recommendation to optimize resources utilization:


Close all applications not needed
Have a swap file in the faster disk of about 16GB
If you are running a VM it should be in an SSD

Do not proceed if there is a space on the network folder path.

40
3DEXPERIENCE: Server Name Configuration

Before any installation, a Server Name convention must be defined. You will modify the FQDN of the services for this training.

This is important in order to ensure a legal server name/SSL identification.

Refer the link to name the server:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

https://support.microsoft.com/en-us/help/909264/naming-conventions-in-active-directory-for-computers,-domains,-sites,-and-ous

In short, avoid most character that is not alpha-numerical.

backslash (\) number sign (#)


slash mark (/) dollar sign ($)
colon (:) percent (%)
asterisk (*) caret (^)
question mark (?) ampersand (&)
quotation mark (") apostrophe (')
less than sign (<) parentheses (())
greater than sign (>) braces ({})
vertical bar (|) underscore (_)
comma (,) white space (blank)
tilde (~)
exclamation point (!)
at sign (@)

41
3DEXPERIENCE: Server Name Configuration

For trainee's who are using the 3DS provided infrastructure, these steps are already done, but always have a look.

In your server edit the file: C:\Windows\System32\drivers\etc\hosts, update the IP’s: <Your ACTUAL VM IP> 3dpassport.mytraining.com
<Your ACTUAL VM IP> 3ddashboard.mytraining.com
127.0.0.1 3dexperience.mytraining.com <Your ACTUAL VM IP> untrusted.mytraining.com
127.0.0.1 database.mytraining.com <Your ACTUAL VM IP> 3dsearch.mytraining.com
<Your ACTUAL VM IP> 3dspace.mytraining.com
127.0.0.1 3dpassport.mytraining.com
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Your ACTUAL VM IP> 3dcomment.mytraining.com


127.0.0.1 3ddashboard.mytraining.com <Your ACTUAL VM IP> 3dnotification.mytraining.com
<Your ACTUAL VM IP> fcscentral.mytraining.com
127.0.0.1 untrusted.mytraining.com <Your ACTUAL VM IP> 3dswym.mytraining.com
127.0.0.1 3dsearch.mytraining.com <Your ACTUAL VM IP> help.mytraining.com
127.0.0.1 3dspaceindex.mytraining.com
127.0.0.1 3dindex.mytraining.com
127.0.0.1 3dspace.mytraining.com On the client machine you only need the
127.0.0.1 internal.mytraining.com frontend FQDN.
127.0.0.1 3dcomment.mytraining.com
127.0.0.1 3dnotification.mytraining.com
127.0.0.1 ensures the traffic stays
127.0.0.1 fcscentral.mytraining.com
INSIDE our all-in-one server
127.0.0.1 smtp.mytraining.com
127.0.0.1 3dswym.mytraining.com
127.0.0.1 3dswymindex.mytraining.com
127.0.0.1 help.mytraining.com C:\Users\dsadmin>ping -4 3dpassport.mytraining.com

Pinging 3dpassport.mytraining.com [127.0.0.1] with 32 bytes of data:


Reply from 127.0.0.1: bytes=32 time<1ms TTL=128 In real life, we don't need to
Reply from 127.0.0.1: bytes=32 time<1ms TTL=128 define these hosts details as
Reply from 127.0.0.1: bytes=32 time<1ms TTL=128
Reply from 127.0.0.1: bytes=32 time<1ms TTL=128 the network team must
define these FQDN in the
Ping statistics for 127.0.0.1:
Packets: Sent = 4, Received = 4, Lost = 0 (0% loss), DNS.
Approximate round trip times in milli-seconds:
Minimum = 0ms, Maximum = 0ms, Average = 0ms

42
3DEXPERIENCE: Server Name Configuration

Save host files on both client and server.


Observe that you need to restart Notepad++ in Administrator mode.
Click Yes so that the content can be saved.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

43
Java Configuration

Topics to be covered:

1. Introduction
2. Java Configuration
3. Apache Configuration
4. TomEE+ Configuration
5. SSL Configuration
Java

Java configuration is an important prerequisite of the platform.

Ensure the following:


DO NOT auto update the java version
The selected Java is for this application only
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Any update needs to be managed as a minor code revision and tested thoroughly
64bits, for servers: D:\3DEXPERIENCE\Java64\jdk17\
64bits, for clients: C:\Program Files\Semeru\jre-17.0.3.7-openj9

45
Java Key parameters

Managing the java is always a topic of conversation! Here are a few options that may be encountered:
IT option : Java was pre-installed and is controlled by the local IT team
3DS option : Use the internal provided Java from the 3DS installer
Your own : You control totally this java and understand the maintenance responsibility
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

All have the pros and cons and mostly determined by


Personal preference
Area of responsibility

For this training we are using the "Your own" options.

46
Apache Configuration

Topics to be covered:

1. Introduction
2. Java Configuration
3. Apache Configuration
4. TomEE+ Configuration
5. SSL Configuration
About Apache

Apache is the web server for the 3DEXPERIENCE platform.

Connection to all 3DEXPERIENCE platform services is done via https protocol for security reasons.

In order for the application to be contacted by its clients, a set comprising reverse proxy (for ending https calls) and load balancer (for high
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

availability) should be cascaded between the client and the application server for the service. These two functions may be achieved by Apache.

48
Exercise: Apache Configuration

Before starting with configuration, verify the installation of Apache at D:\Apache24


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

10 minutes

49
Apache Configuration (1/6)

1. Open Notepad++ in Administrator mode. Ensure that you have necessary permission to edit files.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Backup the httpd.conf to httpd.conf.original file in D:\Apache24\conf

50
Apache Configuration (2/6)

3. Edit the D:\Apache24\conf\httpd.conf file as follows:


a. Update the parameter SRVROOT so that it reflects in the installation path.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Near the end of the file, you will find the ssl_module tag. Comment each line of the section.

c. At the end of the file, append the following two lines and save the file.
# 3DEXPERIENCE configuration file
include D:\3DEXPERIENCE\conf\3dexperience.conf

d. Create new file 3dexperience.conf under the folder D:\3DEXPERIENCE\conf


The SSL configuration for each vhost will be added in the 3dexperience.conf

51
Apache Configuration (3/6)

e. These are already enabled by default in httpd.conf:


LoadModule authz_core_module modules/mod_authz_core.so
LoadModule log_config_module modules/mod_log_config.so
LoadModule setenvif_module modules/mod_setenvif.so
LoadModule socache_shmcb_module modules/mod_socache_shmcb.so
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

LoadModule ssl_module modules/mod_ssl.so


LoadModule authz_host_module modules/mod_authz_host.so
LoadModule dir_module modules/mod_dir.so
LoadModule mime_module modules/mod_mime.so
LoadModule alias_module modules/mod_alias.so

Edit the 3dexperience.conf file by adding the following lines:


I.# 3DEXPERIENCE Master configuration file
II.# Recommended modules based on Program directory R2023x GA
III.Listen 443
IV.LoadModule cache_module modules/mod_cache.so
V.LoadModule cache_disk_module modules/mod_cache_disk.so
VI.LoadModule deflate_module modules/mod_deflate.so
VII.LoadModule filter_module modules/mod_filter.so
VIII.LoadModule headers_module modules/mod_headers.so
IX.LoadModule proxy_module modules/mod_proxy.so
X.LoadModule proxy_http_module modules/mod_proxy_http.so
XI.LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so
XII.LoadModule rewrite_module modules/mod_rewrite.so
XIII.LoadModule slotmem_shm_module modules/mod_slotmem_shm.so

52
Apache Configuration (4/6)

SSLSessionCache "shmcb:${SRVROOT}/logs/ssl_scache(512000)"
SSLSessionCacheTimeout 300
SSLCryptoDevice builtin
KeepAlive On
KeepAliveTimeout 6
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

MaxKeepAliveRequests 400

#Cache
CacheRoot "D:\Apache24\cacheroot"
CacheEnable disk "/"
CacheDirLevels 5
CacheDirLength 2

#Apache User Access Lock


EnableMMAP off
EnableSendFile on
AcceptFilter http none
AcceptFilter https none
Save the file.

f. Create folder D:\Apache24\cacheroot (you can use “mkdir D:\Apache24\cacheroot” in command prompt to ensure there is no error in
folder name)

53
Apache Configuration (5/6)

4. Open a command prompt using Run as administrator.


5. Execute the following commands to first test and then install Apache.

cmd> cd /d D:\Apache24\bin
D:\Apache24\bin> httpd.exe –t
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

D:\Apache24\bin> httpd.exe –k install

If any error is detected you


must fix it prior to continuing.

-t for testing

6. Go to “Services” and start the service:

54
Apache Configuration (6/6)

6. Open a Web browser to check the URL: http://localhost:80/


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

7. Stop the service

55
Exercise Recap: Apache Configuration

1. In this exercise, you have:

a. Configured Apache
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

56
TomEE+ Configuration

Topics to be covered:

1. Introduction
2. Java Configuration
3. Apache Configuration
4. TomEE+ Configuration
5. SSL Configuration
About TomEE+

TomEE+ is an application server.

TomEE+ provides a way to define resources that can be injected into managed components inside an application.

Each service is associated with a separate TomEE+.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

58
Exercise: TomEE+ Configuration

In this exercise, we will configure TomEE+ for each service that will be installed.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

20 minutes

59
TomEE+

Before starting with "TomEE+ configuration" verify the following folder structure below with the already installed TomEE+ for different services:
D:\3DEXPERIENCE\TomEE
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

60
TomEE+ Configuration

For each TomEE+ these steps will be followed :


a. Creation of a setenv.bat file
b. Cleaning of all default webapps
c. Creation of a test-app for SSL validation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. SETENV.BAT file:
a. Open a command prompt using “run as Administrator”, and go to D: drive: (use the already opened one)

2. Execute the following commands:


echo REM Start Default 3DEXP TomEE+ Configuration> EmptyFile.txt
echo set JAVA_HOME=D:\3DEXPERIENCE\Java64\jdk17>> EmptyFile.txt
echo set TITLE=^%cd^%>> EmptyFile.txt

61
TomEE+ Configuration

3. Execute the following commands:


set TMPVAR=D:\3DEXPERIENCE\TomEE
type EmptyFile.txt > %TMPVAR%\TomEE3DComment\bin\setenv.bat
type EmptyFile.txt > %TMPVAR%\TomEE3DDashboard\bin\setenv.bat
type EmptyFile.txt > %TMPVAR%\TomEE3DPassport\bin\setenv.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

type EmptyFile.txt > %TMPVAR%\TomEE3DSpace\bin\setenv.bat


type EmptyFile.txt > %TMPVAR%\TomEE3DSpaceInternal\bin\setenv.bat
type EmptyFile.txt > %TMPVAR%\TomEEFCSCentral\bin\setenv.bat
type EmptyFile.txt > %TMPVAR%\TomEEFedSearch\bin\setenv.bat
type EmptyFile.txt > %TMPVAR%\TomEE3DSwym\bin\setenv.bat
del EmptyFile.txt

set TMP2VAR=set PATH=^%PATH^%;D:\3DEXPERIENCE\R2023x


echo %TMP2VAR%\3DComment\win_b64\code\bin>> %TMPVAR%\TomEE3DComment\bin\setenv.bat
echo %TMP2VAR%\3DDashboard\win_b64\code\bin>> %TMPVAR%\TomEE3DDashboard\bin\setenv.bat
echo %TMP2VAR%\3DPassport\win_b64\code\bin>> %TMPVAR%\TomEE3DPassport\bin\setenv.bat
echo %TMP2VAR%\3DSpace\win_b64\code\bin>> %TMPVAR%\TomEE3DSpace\bin\setenv.bat
echo %TMP2VAR%\3DSpace\win_b64\code\bin>> %TMPVAR%\TomEE3DSpaceInternal\bin\setenv.bat
echo %TMP2VAR%\FCSCentral\win_b64\code\bin>> %TMPVAR%\TomEEFCSCentral\bin\setenv.bat
echo %TMP2VAR%\FedSearch\win_b64\code\bin>> %TMPVAR%\TomEEFedSearch\bin\setenv.bat
echo %TMP2VAR%\3DSwym\win_b64\code\bin>> %TMPVAR%\TomEE3DSwym\bin\setenv.bat

62
TomEE+ Configuration

4. CATALINA_HOME:
In the same command prompt, execute the following commands:

echo set CATALINA_HOME=%TMPVAR%\TomEE3DComment>> %TMPVAR%\TomEE3DComment\bin\setenv.bat


echo set CATALINA_HOME=%TMPVAR%\TomEE3DDashboard>> %TMPVAR%\TomEE3DDashboard\bin\setenv.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

echo set CATALINA_HOME=%TMPVAR%\TomEE3DPassport>> %TMPVAR%\TomEE3DPassport\bin\setenv.bat


echo set CATALINA_HOME=%TMPVAR%\TomEE3DSpace>> %TMPVAR%\TomEE3DSpace\bin\setenv.bat
echo set CATALINA_HOME=%TMPVAR%\TomEE3DSpaceInternal>> %TMPVAR%\TomEE3DSpaceInternal\bin\setenv.bat
echo set CATALINA_HOME=%TMPVAR%\TomEEFCSCentral>> %TMPVAR%\TomEEFCSCentral\bin\setenv.bat
echo set CATALINA_HOME=%TMPVAR%\TomEEFedSearch>> %TMPVAR%\TomEEFedSearch\bin\setenv.bat
echo set CATALINA_HOME=%TMPVAR%\TomEE3DSwym>> %TMPVAR%\TomEE3DSwym\bin\setenv.bat

The echo command will take into account all spaces. Ensure that the command ends with >> and not the <Space>.
TomEE+ setenv.bat file are only read by the startup.bat and shutdown.bat scripts, when the service will be created it will not read this file.

63
TomEE+ Configuration

5. webapps:
In the same command prompt, execute the following commands:
move %TMPVAR%\TomEE3DComment\webapps %TMPVAR%\TomEE3DComment\webapps.ori
move %TMPVAR%\TomEE3DDashboard\webapps %TMPVAR%\TomEE3DDashboard\webapps.ori
move %TMPVAR%\TomEE3DPassport\webapps %TMPVAR%\TomEE3DPassport\webapps.ori
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

move %TMPVAR%\TomEE3DSpace\webapps %TMPVAR%\TomEE3DSpace\webapps.ori


move %TMPVAR%\TomEE3DSpaceInternal\webapps %TMPVAR%\TomEE3DSpaceInternal\webapps.ori
move %TMPVAR%\TomEEFCSCentral\webapps %TMPVAR%\TomEEFCSCentral\webapps.ori
move %TMPVAR%\TomEEFedSearch\webapps %TMPVAR%\TomEEFedSearch\webapps.ori
move %TMPVAR%\TomEE3DSwym\webapps %TMPVAR%\TomEE3DSwym\webapps.ori

mkdir %TMPVAR%\TomEE3DComment\webapps\test-3dcomment
mkdir %TMPVAR%\TomEE3DDashboard\webapps\test-3ddashboard
mkdir %TMPVAR%\TomEE3DPassport\webapps\test-3dpassport
mkdir %TMPVAR%\TomEE3DSpace\webapps\test-3dspace
mkdir %TMPVAR%\TomEE3DSpaceInternal\webapps\test-internal
mkdir %TMPVAR%\TomEEFCSCentral\webapps\test-fcs
mkdir %TMPVAR%\TomEEFedSearch\webapps\test-federated
mkdir %TMPVAR%\TomEE3DSwym\webapps\test-3dswym

64
TomEE+ Configuration

6. Test index.html: In the same command prompt, execute the following commands:

set TMPAPP=3DComment works!


echo %TMPAPP%> %TMPVAR%\TomEE3DComment\webapps\test-3dcomment\index.html
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

set TMPAPP=3DDashboard works!


echo %TMPAPP%> %TMPVAR%\TomEE3DDashboard\webapps\test-3ddashboard\index.html

set TMPAPP=3DPassport works!


echo %TMPAPP%> %TMPVAR%\TomEE3DPassport\webapps\test-3dpassport\index.html

set TMPAPP=3DSpace works!


echo %TMPAPP%> %TMPVAR%\TomEE3DSpace\webapps\test-3dspace\index.html

set TMPAPP=3DSpaceInternal works!


echo %TMPAPP%> %TMPVAR%\TomEE3DSpaceInternal\webapps\test-internal\index.html

set TMPAPP=FCS Central works!


echo %TMPAPP%> %TMPVAR%\TomEEFCSCentral\webapps\test-fcs\index.html

set TMPAPP=3DSearch works!


echo %TMPAPP%> %TMPVAR%\TomEEFedSearch\webapps\test-federated\index.html

set TMPAPP=3DSwym works!


echo %TMPAPP%> %TMPVAR%\TomEE3DSwym\webapps\test-3dswym\index.html

65
TomEE+ Configuration

7. server.xml:
For each of the server.xml file, update the Shutdown and HTTP ports at D:\3DEXPERIENCE\TomEE\TomEE<Service name>\conf\server.xml
set NOTE="C:\Program Files\Notepad++\notepad++.exe"
%NOTE% %TMPVAR%\TomEEFCSCentral\conf\server.xml
%NOTE% %TMPVAR%\TomEE3DSwym\conf\server.xml
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

%NOTE% %TMPVAR%\TomEE3DComment\conf\server.xml
%NOTE% %TMPVAR%\TomEE3DSpaceInternal\conf\server.xml
%NOTE% %TMPVAR%\TomEE3DSpace\conf\server.xml
%NOTE% %TMPVAR%\TomEEFedSearch\conf\server.xml
%NOTE% %TMPVAR%\TomEE3DDashboard\conf\server.xml
%NOTE% %TMPVAR%\TomEE3DPassport\conf\server.xml

66
TomEE+ Configuration

The table illustrating the ports for each service.

In the HTTP tag of the server.xml


Service Shut-down HTTP
File, make sure to add the URIEncoding and server description based on the service name.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

TomEE3DPassport 8005 8080


URIEncoding="UTF-8" TomEE3DDashboard 8105 8180
server="Apache TomEE TomEE3DPassport"
TomEEFedSearch 8205 8280

TomEE3DSpace 8305 8380


For example: 3DPassport server.xml is considered below: TomEE3DSpaceInternal 8405 8480

TomEE3DComment 8505 8580

Reserved for Notification N/A 8680

TomEE3DSwym 8705 8780

TomEEFCSCentral 8805 8880


Because of a Tomcat / TomEE vulnerability, it is highly recommended not to enable AJP
https://kb.dsxclient.3ds.com/mashup-ui/page/document?q=docid:QA00000065564

67
TomEE+ Configuration

8. Context.xml:
Add the cache configuration:

<Resources cachingAllowed="true" cacheMaxSize="100000" />


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

TomEE3DSpace at D:\3DEXPERIENCE\TomEE\TomEE3DSpace\conf\context.xml
TomEE3DSpaceInternal at D:\3DEXPERIENCE\TomEE\TomEE3DSpaceInternal\conf\context.xml

68
TomEE+ Configuration

9. service.bat:
In the same command prompt, execute the following commands:
set NOTEPAD="C:\Program Files\Notepad++\notepad++.exe"
%NOTEPAD% %TMPVAR%\TomEE3DComment\bin\service.bat
%NOTEPAD% %TMPVAR%\TomEE3DDashboard\bin\service.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

%NOTEPAD% %TMPVAR%\TomEE3DPassport\bin\service.bat
%NOTEPAD% %TMPVAR%\TomEE3DSpace\bin\service.bat
%NOTEPAD% %TMPVAR%\TomEE3DSpaceInternal\bin\service.bat
%NOTEPAD% %TMPVAR%\TomEEFCSCentral\bin\service.bat
%NOTEPAD% %TMPVAR%\TomEEFedSearch\bin\service.bat
%NOTEPAD% %TMPVAR%\TomEE3DSwym\bin\service.bat

For each of the service.bat file, include second line, calling the specific service environment file.

At this point, this file is only prepared and not ready to be executed.
10. Save all the files opened by notepad++.

69
TomEE+ html

11. For the validation check to test the TomEE+ configurations for all service without certificates, we have created a html file in the desktop.
Location :- C:\Users\dsadmin\Desktop\MyURLs.html
Using the html, we will be accessing all the HTTP Test URLs.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

70
SSL Configuration

Topics to be covered:

1. Introduction
2. Java Configuration
3. Apache Configuration
4. TomEE+ Configuration
5. SSL Configuration
About SSL

Create a certificate that will be used by Apache. The TomEE+ applications do not use
this certificate. Below is a simplified view of the service security communications.

Certificates should always be provided, although it’s very common that you need
them prior for validation. At the end of the day, the final Apache configuration will be
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

executed by the customer


TomEE FedSearch https://URL:port/URI

CA certificate: A CA certificate is a digital certificate issued by a certificate JS 3DNotification


authority (CA), so SSL clients (such as web browsers) can use it to verify the
HTTP HTTPS
SSL certificates sign by this CA. TomEE
3DComment
TomEE
Key file: crt and key files represent both parts of a certificate, key being the 3DPassport Proxy
private key to the certificate and crt being the signed certificate.
TomEE 3DSwym

Signing certificate: Encrypt the data in transit between two systems TomEE FCS DSLS
3DDashboard

Server certificate: Server certificates typically are issued to hostnames, which TomEE3DSpace
could be a machine name (such as 'XYZ-SERVER-01') or domain name (such
as 'www.digicert.com'). A web browser reaching the server validates that the
TLS/SSL server certificate is authentic.

Keystore: A Java KeyStore (JKS) is a repository of security certificates –


either authorization certificates or public key certificates – plus
corresponding private keys, used for instance in TLS encryption.

72
About SSL

These technologies are used to encrypt your internet traffic. Understanding the Certification Chain and the physical location
of these certificates is important.

Each certificate contains <Subject + Validity + Issuer> and is stored in the keystore.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

For the training avoid wildcard Server Name certificate, they are not bad but can be confusing during the Apache configuratio n.
The FQDN definition must include at least one sub domain.
Valid: *.mytraining.localdomain Invalid: *.mytraining
Valid: server.mytraining.localdomain Invalid: server.mytraining

At the end of the day this is what you need to achieve:

73
SSL Generation Process

The OpenSSL is a software library to be used in applications that need to secure communications over network.

1. Create CA certificate and CA private key.


2. Send Server certificate signing request and server private key to the respective authority.
3. Verify Server certificate signing request.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Create and sign Server certificate and server private key.


5. Verify Server certificate.
6. Copy server key and certificate.
7. Install CA certificate.

This process is followed on both the server and client to secure the communication.

Certificates signed by certificate authorities


You can obtain certificates from any certificate creation public authority. If the organization has its own authority, it can generate the certificates and get
them signed by the same authority.

Self-signed certificates
You can use the Self-signed certificates, but we strongly recommend that you do not use them. Using them will generate many warnings and/or errors
from components that do not recognize the certificate as valid or safe.

74
SSL Generation Types

This can be done in two ways, directly on the server or in your laptop, certificate creation has nothing to do with the actual physical server or VM.

In this training the 3DEXPERIENCE server is used to generate all certificates.

Optionally it can be possible to create the certificates in your host laptop. Certificates are not linked to where they are c reated, a batch can automate
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

this process for any number of FQDN’s servers . List of prerequisites that would be needed:
In the laptop something like:
C:\MyCertBuilder\Apache24
C:\MyCertBuilder\jdk17
No need to have the service running, only binaries will be used.
Create a batch file C:\MyCertBuilder\MyBatBuilder.bat This option is not being used
in this training.
And copy and paste all the steps in the next few slides into that batch file.
Change path and location and values, but all can be parameterized.

75
Exercise: Generate and Configure Self-Signed Certificate

SSL certificate creation will require the use of:


Apache to create the certificates with openssl command
Java code to import the certificates in the keystore with keytool command
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

10 minutes

76
Generate and Configure Self-Signed Certificate

1. Create a directory "D:\3DEXPERIENCE\conf\ssl\sslcnf“


(you can use mkdir D:\3DEXPERIENCE\conf\ssl\sslcnf in command prompt to make sure the folder is created in the right location)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Create a file "openssl-supp.cnf" in the above directory and add below content in the file.

# OpenSSL example configuration file.


# This is mostly being used for generation of certificate requests.
#
[ req ]
distinguished_name = req_distinguished_name
req_extensions = v3_req

[ req_distinguished_name ]
countryName_default = FR
stateOrProvinceName_default = IDF
localityName_default = FRANCE
commonName = 3dexperience.mytraining.com

77
Generate and Configure Self-Signed Certificate

[ v3_req ]
# Extensions to add to a certificate request
basicConstraints = CA:FALSE
keyUsage = nonRepudiation, digitalSignature, keyEncipherment
extendedKeyUsage = serverAuth
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

subjectAltName = @alt_names
#
[ alt_names ]
DNS.1 = 3dexperience.mytraining.com
DNS.2 = database.mytraining.com
DNS.3 = 3dpassport.mytraining.com
DNS.4 = 3ddashboard.mytraining.com
DNS.5 = untrusted.mytraining.com
DNS.6 = 3dsearch.mytraining.com
DNS.7 = 3dspaceindex.mytraining.com
DNS.8 = 3dspace.mytraining.com
DNS.9 = internal.mytraining.com
DNS.10 = 3dcomment.mytraining.com
DNS.11 = 3dnotification.mytraining.com
DNS.12 = fcscentral.mytraining.com
DNS.13 = 3dindex.mytraining.com
DNS.14 = smtp.mytraining.com
DNS.15 = 3dswym.mytraining.com
DNS.16 = 3dswymindex.mytraining.com
DNS.17 = help.mytraining.com
DNS.18 = dslauncher.mytraining.com

78
Generate and Configure Self-Signed Certificate

3. SSL Certificate Creation for different 3DEXPERIENCE platform services


Open a command prompt as Run as administrator, execute the following commands (you can use the already open one).

4. Execute the below script for the generation and configuration of Self-Signed Certificate for all the services.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

CMD> C:\Users\dsadmin\Desktop\cert_gen.bat

79
Snapshot : cert_gen.bat

Open the file and view the contents of the file “cert_gen.bat”
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

80
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Result Snapshot : cert_gen.bat

81
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Result Snapshot : cert_gen.bat

82
Generate and Configure Self-Signed Certificate

5. Verify that, you have the below message at the end of the successful execution of the script.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

6. Verify that, 2 certificates and 1 serial file will be generated in "D:\3DEXPERIENCE\conf\ssl"


3dexperience.mytraining.crt
cacert.crt
caserial.srl

7. Verify that below files are generated in "D:\3DEXPERIENCE\conf\key" and "D:\3DEXPERIENCE\conf\csr" folders:

83
Generate and Configure Self-Signed Certificate

8. Install the CA certificate: D:\3DEXPERIENCE\conf\ssl\cacert.crt


Copy the cacert.crt file and save on the local machine.
a. Open the file location, RMB + Install Certificate
b. Select following options:
Local Machine
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Place all certificates in the following store and click on Browse


c. Choose Trusted Root Certification Authorities folder, click Next and choose Finish.

84
Generate and Configure Self-Signed Certificate

9. Perform the following steps to validate all 3DEXPERIENCE platform services in the Mozilla Firefox.

a. Open the browser

b. Go to Open Applications Menu (Top right corner)


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Select Settings > Privacy and Security

d. In the Certificates section, click View Certificates

e. Select Authorities tab and select Import

f. Navigate to the certificate file location and select the cacert.crt

g. Select both options, “Trust to identify web sites” and “Trust to identify email Users”.
Click OK
The certificate is imported and is available to open all the services

h. Close the browser

85
Exercise Recap: Generate and Configure Self-Signed Certificate

1. In this exercise, you have:

 Configured Self-Signed Certificate for each service.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

86
Exercise: Configure Apache Service Virtual Host

Prior to the 3DEXPERIENCE platform installation, ensure that everything related to Apache, Java, TomEE+ and SSL are working properly.
To achieve this the Apache configuration with respect to test URI for each service to be done.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

10 minutes

87
Apache Service Virtual Host – 3DPassport

1. Edit the file 3dexperience.conf file at D:\3DEXPERIENCE\conf

# ##################################################################################
# Virtual host configuration for 3DPassport service
<VirtualHost *:443>
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ServerName 3dpassport.mytraining.com
ServerAlias 3dpassport
ErrorLog logs/3dpassport.err
TransferLog logs/3dpassport.log
Customlog logs/3dpassport_Access.log 3DEXP
LogFormat "[%{%d/%b/%Y:%H:%M:%S %z}t] | %>s | %{ms}T ms | %b B | %h | %{X-Forwarded-For}i | %{JSESSIONID}C |
%{SERVERID}C | \"%r\"" 3DEXP
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\3dexperience.mytraining.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\key\3dexperience.mytraining.key
ProxyPass /test-3dpassport http://3dpassport.mytraining.com:8080/test-3dpassport
ProxyPassReverse /test-3dpassport http://3dpassport.mytraining.com:8080/test-3dpassport

#XXXX Future fragment file XXXX


</VirtualHost>

88
Apache Service Virtual Host – 3DDashboard

# ##################################################################################
# Virtual host configuration for 3DDashboard service
<VirtualHost *:443>
ServerName 3ddashboard.mytraining.com
ServerAlias 3ddashboard
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ErrorLog logs/3ddashboard.err
TransferLog logs/3ddashboard.log
Customlog logs/3ddashboard_Access.log 3DEXP
LogFormat "[%{%d/%b/%Y:%H:%M:%S %z}t] | %>s | %{ms}T ms | %b B | %h | %{X-Forwarded-For}i | %{JSESSIONID}C | %{SERVERID}C |
\"%r\"" 3DEXP
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\3dexperience.mytraining.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\key\3dexperience.mytraining.key
ProxyPass /test-3ddashboard http://3ddashboard.mytraining.com:8180/test-3ddashboard
ProxyPassReverse /test-3ddashboard http://3ddashboard.mytraining.com:8180/test-3ddashboard

#XXXX Future fragment file XXXX


</VirtualHost>

89
Apache Service Virtual Host – 3DSearch

# ##################################################################################
# Virtual host configuration for 3DSearch service
<VirtualHost *:443>
ServerName 3dsearch.mytraining.com
ServerAlias FedSearch
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ErrorLog logs/FedSearch.err
TransferLog logs/FedSearch.log
Customlog logs/3dsearch_Access.log 3DEXP
LogFormat "[%{%d/%b/%Y:%H:%M:%S %z}t] | %>s | %{ms}T ms | %b B | %h | %{X-Forwarded-For}i | %{JSESSIONID}C | %{SERVERID}C |
\"%r\"" 3DEXP
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\3dexperience.mytraining.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\key\3dexperience.mytraining.key
ProxyPass /test-federated http://3dsearch.mytraining.com:8280/test-federated
ProxyPassReverse /test-federated http://3dsearch.mytraining.com:8280/test-federated

#XXXX Future fragment file XXXX


</VirtualHost>

90
Apache Service Virtual Host – 3DSpace

# ##################################################################################
# Virtual host configuration for 3dspace service
<VirtualHost *:443>
ServerName 3dspace.mytraining.com
ServerAlias 3dspace
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ErrorLog logs/3dspace.err
TransferLog logs/3dspace.log
Customlog logs/3dspace_Access.log 3DEXP
LogFormat "[%{%d/%b/%Y:%H:%M:%S %z}t] | %>s | %{ms}T ms | %b B | %h | %{X-Forwarded-For}i | %{JSESSIONID}C |
%{SERVERID}C | \"%r\"" 3DEXP
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\3dexperience.mytraining.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\key\3dexperience.mytraining.key
ProxyPass /test-3dspace http://3dspace.mytraining.com:8380/test-3dspace
ProxyPassReverse /test-3dspace http://3dspace.mytraining.com:8380/test-3dspace

#XXXX Future fragment file XXXX


</VirtualHost>

91
Apache Service Virtual Host - 3DSpace Internal

# ##################################################################################
# Virtual host configuration for 3dspace Internal service
<VirtualHost *:443>
ServerName internal.mytraining.com
ServerAlias 3dspaceinternal
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ErrorLog logs/3dspaceinternal.err
TransferLog logs/3dspaceinternal.log
Customlog logs/3dspaceinternal_Access.log 3DEXP
LogFormat "[%{%d/%b/%Y:%H:%M:%S %z}t] | %>s | %{ms}T ms | %b B | %h | %{X-Forwarded-For}i | %{JSESSIONID}C | %{SERVERID}C |
\"%r\"" 3DEXP
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\3dexperience.mytraining.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\key\3dexperience.mytraining.key
ProxyPass /test-internal http://internal.mytraining.com:8480/test-internal
ProxyPassReverse /test-internal http://internal.mytraining.com:8480/test-internal

#XXXX Future fragment file XXXX


</VirtualHost>

92
Apache Service Virtual Host - 3DComment

# ##################################################################################
# Virtual host configuration for 3DComment service
<VirtualHost *:443>
ServerName 3dcomment.mytraining.com
ServerAlias 3dcomment
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ErrorLog logs/3dcomment.err
TransferLog logs/3dcomment.log
Customlog logs/3dcomment_Access.log 3DEXP
LogFormat "[%{%d/%b/%Y:%H:%M:%S %z}t] | %>s | %{ms}T ms | %b B | %h | %{X-Forwarded-For}i | %{JSESSIONID}C | %{SERVERID}C |
\"%r\"" 3DEXP
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\3dexperience.mytraining.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\key\3dexperience.mytraining.key
ProxyPass /test-3dcomment http://3dcomment.mytraining.com:8580/test-3dcomment
ProxyPassReverse /test-3dcomment http://3dcomment.mytraining.com:8580/test-3dcomment

#XXXX Future fragment file XXXX


</VirtualHost>

93
Apache Service Virtual Host - FCS Central

# ##################################################################################
# Virtual host configuration for FCS Central service
<VirtualHost *:443>
ServerName fcscentral.mytraining.com
ServerAlias fcscentral
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ErrorLog logs/fcscentral.err
TransferLog logs/fcscentral.log
Customlog logs/fcscentral_Access.log 3DEXP
LogFormat "[%{%d/%b/%Y:%H:%M:%S %z}t] | %>s | %{ms}T ms | %b B | %h | %{X-Forwarded-For}i | %{JSESSIONID}C | %{SERVERID}C |
\"%r\"" 3DEXP
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\3dexperience.mytraining.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\key\3dexperience.mytraining.key
ProxyPass /test-fcs http://fcscentral.mytraining.com:8880/test-fcs
ProxyPassReverse /test-fcs http://fcscentral.mytraining.com:8880/test-fcs

#XXXX Future fragment file XXXX


</VirtualHost>

94
Apache Service Virtual Host - 3DSwym

# ##################################################################################
# Virtual host configuration for 3DSwym service
<VirtualHost *:443>
ServerName 3dswym.mytraining.com
ServerAlias 3dswym
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ErrorLog logs/3dswym.err
TransferLog logs/3dswym.log
Customlog logs/3dswym_Access.log 3DEXP
LogFormat "[%{%d/%b/%Y:%H:%M:%S %z}t] | %>s | %{ms}T ms | %b B | %h | %{X-Forwarded-For}i | %{JSESSIONID}C | %{SERVERID}C |
\"%r\"" 3DEXP
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\3dexperience.mytraining.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\key\3dexperience.mytraining.key
ProxyPass /test-3dswym http://3dswym.mytraining.com:8780/test-3dswym
ProxyPassReverse /test-3dswym http://3dswym.mytraining.com:8780/test-3dswym

#XXXX Future fragment file XXXX


</VirtualHost>

95
Apache Service Virtual Host - 3DNotification

3DNotification is a special situation it will be handled during the core installation module.

# ##################################################################################
# Virtual host configuration for 3DNotification service
<VirtualHost *:443>
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ServerName 3dnotification.mytraining.com
ServerAlias 3dnotification
ErrorLog logs/3dnotification.err
TransferLog logs/3dnotification.log
Customlog logs/3dnotification_Access.log 3DEXP
LogFormat "[%{%d/%b/%Y:%H:%M:%S %z}t] | %>s | %{ms}T ms | %b B | %h | %{X-Forwarded-For}i | %{JSESSIONID}C |
%{SERVERID}C | \"%r\"" 3DEXP
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\3dexperience.mytraining.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\key\3dexperience.mytraining.key

#XXXX Future fragment file XXXX


</VirtualHost>

96
Apache Service Virtual Host

2. Save the file D:\3DEXPERIENCE\conf\3dexperience.conf


Total amount of line should be around 190.

3. Delete all files contained in the D:\Apache24\logs\ folder.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Start the Apache service.

5. Check all “.log” and “.err” files in D:\Apache24\logs\ that are not 0 bytes.

6. Observe that the Apache error.log always has some traces, they should be very minimal.

97
Apache Service Virtual Host

6. Create shortcuts on your desktop for startup.bat and shutdown.bat of each service:
a. Navigate to each D:\3DEXPERIENCE\TomEE\TomEE<Service>\bin folder.
b. Create a shortcut of the startup and shutdown batch files. It is recommended renaming the shortcut based
on Service + Command. Make them readable, short and order them in the desktop.
c. Correct any error that you can spot on the command prompt.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Finally, start them all again. (Example for FCS Central file shown below)

For the training, shortcuts are already available in the Shortcuts


folder on the Desktop as shown in the image

98
Apache Service Virtual Host

7. Open in the Firefox or any other browser :


8. Navigate to C:\Users\dsadmin\Desktop\MyURLs.html and click on the HTTPS Test URLs.
Add MyURLs.html as favorites in the browser.

You will be able to access the other URLs after you installation of all the services.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

99
Exercise Recap: Configure Apache Service Virtual Host

1.In this exercise, you have:

 Configured the Apache Service Virtual Host for all the services.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

100
Summary

Middleware Configuration

Ensure that the following configurations are completed before starting the installation of the 3DEXPERIENCE platform:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Java configuration

 Apache configuration

 TomEE+ configuration

 SSL Certificate generation and deployment

101
Lesson 4: Database

SQL Server Database Configuration


Instance creation
Object creation

Oracle Database Configuration


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Net Services configuration


Database creation

1 hour

102
SQL Server Database Configuration

Topics to be covered:

SQL Server Database Configuration


Oracle Database Configuration
Exercise: Configure SQL Server

In this exercise, you will configure the SQL Server using Microsoft SQL Server Management Studio.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

YourServerName\

YourServerName\

50 minutes

104
Pre-check to configure the SQL Server

1. Pre-check that following services exist.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Select Start > Administrative Tools > Computer Management > Services and Applications > SQL Server Configuration Manager > SQL Server
Network Configuration and observe the reference to the communication protocol for X3DEXP instance.

105
Connect to SQL Server (1/5)

1. Open a dbadmin command prompt.


You don’t need to log off, when running command under another user, execute a
command as the following: (if needed)
cmd> runas /user:dbadmin cmd
Enter the password for dbadmin:Zaq1@WsxCde3
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Execute the following command to open the Microsoft SQL Server Management Studio.
cmd> cd C:\Program Files (x86)\Microsoft SQL Server Management Studio 18\Common7\IDE
C:\Program Files (x86)\Microsoft SQL Server Management Studio 18\Common7\IDE>ssms.exe

YourServerName\

3. Using the Windows Authentication mode, connect to the server:

Either Machine name (host name) or


ip address can be used in server
name
YourServerNam
e\

YourServerNam
e\

106
Connect to SQL Server (2/5)

1. Expand the Security > Logins folder, you should see the “sa” user.
2. Open the Properties of the “sa” user, then update the password to “Zaq1@WsxCde3”.
3. Enable “sa” account
1 2
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

107
Connect to SQL Server (3/5)

4. Open the properties of the instance, In the memory page, update to a training safe value.
5. On a dedicated Database, for max usage, leaving 4-8GB (Maximum Server memory: 8000 MB) for operating system need, consult the local DBA for
recommendations.
6. Close the Studio tool.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Because of the restricted space on the


training machine, set maximum to 8GB.

108
Connect to SQL Server (4/5)

7. Let us make sure that the database can be reached. Open the SQL Server 2019 Configuration Manager. Using the dsadmin user is fine for this
operation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

8. Go to the SQL Server Network Configuration > Protocols for X3DEXP.


Check the Properties of the TCP/IP protocol.

109
Connect to SQL Server (5/5)

9. Go to the IP Addresses tab and add current VM IP Address in IP1 and then to the bottom of the list IPAll.
a. Check the properties of the TCP Port value is 1433, update if necessary and close all windows.

b. Re-start respective SQL services.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

It’s important to understand that the


database configuration and connectivities
are not the responsibility of the platform
admin or installer.
These should always be handled by the
local DBA.
Your responsibilities are to understand the
process and be able to communicate your
need to the DBA.

110
Create Objects for Each Service (1/2)

The next step is the execution of SQL commands.

Cheat-Sheet: OOTB
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Key 3DPassport 3DDashboard 3DSpace 3DNotification 3DComment 3DSwym

DATABASE x3dpassdb x3ddashdb x3dspacedb x3dnotification x3dcomment x3dswym_social


x3dpasstkdb x3dswym_media
x3dswym_widget
USER x3dpass x3ddash x3dspace x3dsn x3dsc x3dsm
X3dpassadmin x3ddashadmin x3dsn_admin x3dsc_admin x3dsm_admin
x3dpasstokens
SCHEMA x3dpassdb x3ddashdb x3dspacedb x3dnotification x3dcomment x3dswym_social
x3dpasstkdb x3dswym_media
x3dswym_widget

111
Create Objects for Each Service (2/2)

1. Create the following directory:


D:\3DEXPERIENCE\R2023x\X3DEXPDB\3dspace
(mkdir D:\3DEXPERIENCE\R2023x\X3DEXPDB\3dspace)

2. Open a command prompt.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3. Execute the command :


cmd> runas /user:dbadmin cmd

4. Create a temp folder - C:\temp

5. Create a file inside the temp folder- MyOutput.txt

6. To graphically monitor the activities execute the command and connect with Windows Authentication:
C:\Program Files (x86)\Microsoft SQL Server Management Studio 18\Common7\IDE\Ssms.exe

7. Run the following command:


sqlcmd -S localhost\X3DEXP –i C:\Users\dsadmin\Desktop\mssql_db_creation.sql -o C:\temp\MyOutput.txt (It will create
your databases and logins)

112
Snapshot : mssql_db_creation.sql

Open the file and view the contents of the file “mssql_db_creation.sql”
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

113
SQL Server - Technical Validation

1. Observe the data files created:


a. D:\3DEXPERIENCE\R2023x\X3DEXPDB\3dspace
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

114
SQL Server - Technical Validation

1. Finally in the Microsoft SQL Server Management Studio, you should see all objects created.
You can close it after validation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

115
SQL Server - Technical Validation

2. Open the Microsoft SQL Server Management Studio, refresh the instance view and expand the Databases.

3. Verify the created databases as below:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Close the Microsoft SQL Server Management Studio or execute quit in the sqlcmd command prompt.

116
Drop/Delete Service Object

Execute the following command to drop a service object.


For example:
ALTER DATABASE [x3dnotification] SET SINGLE_USER WITH ROLLBACK IMMEDIATE;
GO
or
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Right-click the services Database, Users and click Delete.


Ensure that all existing connections are deleted.

Then re-create Database and users for the service accordingly.

117
Uninstall the SQL Server Instance

Execute the following command to uninstall SQL Server:

sqlcmd -S localhost\X3DEXP -U sa -P <DB Password>


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

118
Exercise Recap: SQL Server

1. In this exercise, you have configured the SQL Server.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

119
Oracle Database Configuration

Topics to be covered:

SQL Server Database Configuration


Oracle Database Configuration
Oracle Database Configuration

Topics to be covered:
1. Net Services configuration
2. Database creation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

121
Oracle Database Configuration

In the VM provided, we have installed the Oracle code only, now it's time to finish the below database operations in order to be ready for the
3DEXPERIENCE platform installation.

Proceed with the following actions


1. DB creation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Table space creation


3. Schema creation (user)
4. Schema permission (roles and privileges)
5. Default profile updates

Check the 3DS program directory in order to check that the version is supported:
http://www.3ds.com/support/documentation/program-directories/

Software level used in this training and user:


Oracle 12c, version 12.2.0.1.0
Enterprise Edition
User is dbadmin

122
Exercise: Oracle Database Configuration

In this exercise, you will configure the Oracle database. Configuring the network, that is, a listener and create database.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

50 minutes

123
Configuring the Network (1/6)

1. Open a dbadmin command prompt and Run as administrator


2. Execute the command: netca
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Select Listener configuration > Next

You don’t need to log off, when running command under another user,
execute a command as the following: (if needed)
cmd> runas /user:dbadmin cmd
Enter the password for dbadmin: Zaq1@WsxCde3

124
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3. Select Add > Next


Configuring the Network (2/6)

125
Configuring the Network (3/6)

4. Keep default protocol values proposed and click Next.


5. Keep default protocol Port proposed and click Next.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

126
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

6. Click Next.
Configuring the Network (4/6)

127
Configuring the Network (5/6)

9. Select Naming Methods configuration and click Next.


10. Select Local Naming and Easy Connect Naming from the list of “Available Naming Methods” and move them to “Selected Naming Methods”
using the arrow and click Next.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

128
Configuring the Network (6/6)

11. A confirmation message appears. Click Next.


12. Click Finish.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

129
Create Database (1/9)

1. In the same dbadmin command prompt which was opened earlier, run the command dbca
2. Select Create a database and choose Next
3. In Select Database Creation Mode Choose Advanced Configuration
4. Click on Next
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

130
Create Database (2/9)

5. In Select Database Deployment Type


a. Choose Oracle Single Instance Database as Database Type
b. Choose General Purposes or Transaction Processing as Database Template
6. Click on Next
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

131
Create Database (3/9)

7. In Specify Database Identification Details provide Global Database name and SID as X3DEXP
Unselect “Create as Container Database” option and choose Next
8. Click on the File location Variables to check the file location variables and choose Ok
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

132
Create Database (4/9)

9. In Select Database Storage Option keep the default and choose Next
10. In Select Fast Recovery Option keep the default values and choose Next
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

133
Create Database (5/9)

11. In Specify Network Configuration Details Select the listener and choose Next
Ensure that you use the
listener already created.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

134
Create Database (6/9)

12. In Select Oracle Data Vault Config Option Keep the default values and choose Next
13. In Specify Configuration Options set SGA Size and PGA Size
14. Navigate to Connection mode Tab
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Memory:
SGA size : 3 GB
PGA size : 1 GB

135
Create Database (7/9)

15. In Specify Management Options Select Configure Enterprise Manager (EM) database express and choose Next
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

136
Create Database (8/9)

16. In Specify Database User Credentials Provide the passwords (Zaq1@WsxCde3) and choose Next
17. In Select Database Creation Options Select Create Database and choose Next
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

137
Create Database (9/9)

19. In Summary Click on Finish


20. In Finish validate the EM Database Express URL and Click on Close
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

138
Oracle Database Validation

1. By the end of the installation, an URL link to the EM (https://database.mytraining.com:5500/em) is created.


2. You can use the Enterprise Manager tool instead of sqlplus.

After all configuration is done, disable it. For more detail refer the oracle documentation or your local
DBA.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Oracle Enterprise Manager is very sensitive to the hostname/IP, that is, DNS. This is why DB server
should be a real FQDN machine.
We are not using EM for the training.

Zaq1@WsxCde3

139
Network Configuration and File Validation

Oracle expects to be in a "real" server class machine. Always check the ora files : listener.ora and tnsnames.ora, located in:
C:\app\dbadmin\network\admin

The entries should look as shown below. It is possible to see the actual machine name (IP). This is the default oracle behavior, but for consistency
update the values to reflect the "alias" defined.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

"listener.ora":
LISTENER =
(DESCRIPTION_LIST =
(DESCRIPTION =
(ADDRESS = (PROTOCOL = TCP)(HOST = database.mytraining.com)(PORT = 1521))
(ADDRESS = (PROTOCOL = IPC)(KEY = EXTPROC1521))
)
)
"tnsnames.ora":
LISTENER_X3DEXP =
(ADDRESS = (PROTOCOL = TCP)(HOST = database.mytraining.com)(PORT = 1521))

X3DEXP =
(DESCRIPTION =
(ADDRESS = (PROTOCOL = TCP)(HOST = database.mytraining.com)(PORT = 1521))
(CONNECT_DATA =
(SERVER = DEDICATED)
(SERVICE_NAME = X3DEXP)
)
) Ensure that you restartthe two services “OracleOraDB19Home1TNSListener”
and “OracleServiceX3DEXP” after making changes in the above files.

140
Oracle Database Validation

There are set of commands that need to be executed and checked for installation without any issues.
1. Open a command prompt with Run as Administrator:
tnsping X3DEXP
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Check the SQL Connection


sqlplus / as sysdba

3. Type exit
The validation is successful as verified in the SQL command prompt.

141
Oracle Database Validation

3. Execute lsnrctl status, to verify the Oracle listener status.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

142
Create Tablespace and User

Now we will start preparing the object that will host the 3DEXPERIENCE platform data.

1. In the same Administrator command prompt (dsadmin) used previously, execute the command:
sqlplus / as sysdba
alter profile DEFAULT limit password_life_time UNLIMITED;
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Execute the script for creation of DATA and INDEX tablespaces and Users.
SQL> @C:\Users\dsadmin\Desktop\create_user_schemas_and_tablespaces.ora

143
Snapshot : create_user_schemas_and_tablespaces.ora

Open the file and view the contents of the file “create_user_schemas_and_tablespaces.ora”
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

144
Snapshot : Oracle Database Validation

These are the final validation sqlplus queries to check.

In the same command prompt used previously, continue running the following two SQL
commands:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

select 'INST= '||instance_name from v$instance


union
select 'USR= '||USERNAME||' -- '||DEFAULT_TABLESPACE from DBA_USERS
where USERNAME like 'X3D%‘
union
select 'TBS= '||TABLESPACE_NAME from DBA_TABLESPACES where
TABLESPACE_NAME like 'X3D%' order by 1;

Validate the Character set :


select * from nls_database_parameters where parameter
='NLS_CHARACTERSET';

145
Drop/Delete Sequence, tables, View, Procedures

In Oracle it’s normally faster to drop the user cascade. If you are totally deleting the install, then drop the table spaces. But sometimes you need to re-try
an installation, but your DBA did not grant you the power of dropping the user. Then in order to delete/clear that particular installation, you can use drop
the sequence, tables, view and procedures manually, this could be long.

In the VM we provide a sample drop objects, you can have a look at the file:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

E:\SupportingFiles\clean_out_completely_user_s_schema.ora

Note: This script should be provided by your DBA and can change at each release, only use it with guidance or if you feel comfortable with such
commands.

146
Drop/Delete Sequence, tables, View, Procedures : Snapshot

You must start the SQLPLUS with the user that we need to clean it’s objects.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

147
Summary

Database

In this lesson, you have configured the database of your choice.


 Oracle
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 MSSQL Server

148
Lesson 5: Core Configuration

Introduction
DSLS
DSLS overview
GA Installation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Post configuration
Uninstallation
Global 3DEXPERIENCE platform Installer
3DPassport
3DDashboard
3DSearch
3DSpace Index
3DSpace
3DNotification
3DComment
3DSwym
FCS
FCS Central
3D Indexing Server

10 hours

149
Introduction

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE Platform
Introduction

By now you have installed all the pre-requisites plus the middleware configuration and you are almost ready to proceed with the installation of the
3DEXPERIENCE platform.

This chapter will introduce the core components and will discuss configuration options and key parameters you need to manage for your future
installation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Server Core components :


3DPassport
3DDashboard
3DSearch
3DSpace
3DNotification
3DComment
3DSwym
FCS

Client Core components :


Native Client
Integration Clients

151
3DEXPERIENCE platform: Deployment Overview

This is a practical high level view of the platform, showing the services based on the deployment, that is, installation
and configuration of code. Each element in this schema is an installation and configuration activity.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Apache
SSL END-POINT
Apache HTTPD

WEB
Application
TomEE+
DSLS
CAS NoCAS
Frontend

3DDashboard 3DPassport 3DSpace FCS 3DComment 3DNotification 3DSwym 3DSearch


3DS
CODE
Backend

3DSpace 3DSwym 3DSwym Media


3DIndex
Index Index Server
Server

Storage

Database Shared
Folders

152
3DEXPERIENCE platform: GA Core Installation

As a general rule you will find that all 3DS installations will follow these steps:

Service Overview : Service Description, Architecture & Requirement


Service Key Parameters : Service Options and Key Parameters
Service GA Installation : Service GA Installation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Service GA Post : Service GA Post Activities


Service GA Technical Validation : Service GA Technical Validation of the Installation
Service Uninstallation : Service Standard Uninstallation

1 2 3
Service Configuration GA
Overview Parameters installation

6 5 4
GA
FP GA technical
Post
Installation Validation

OS/DB Activities
Custom Parameters 7 8 9
FP FP Technical Service
3DS Code Process Post Validation Uninstall

153
DSLS

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE Platform
Introduction

The DSLS is often overlooked at the beginning of a deployment. It is a critical component since you will not be able to functionally validate the rest of the
platform if you cannot reach a valid DS license server.

This chapter will introduce the "DS License server" components as well as discuss configuration options and key parameters you will need to manage
for your installation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The DS License server is not dependent on the platform for installation and can be installed at any point in time. It can only be installed on a physical
machine and it should be the first component you install after the documentation. This component is required to license users’ roles in the
3DEXPERIENCE platform.

This installation is mandatory if you are building your own 3DEXPERIENCE platform on your laptop. For those who will be using the provided 3DS
laptop you can proceed with the installation if you wish but it will not be used during the training. The 3DS laptop will access an internal DS License
server.

If you were planning on using your own laptop you should have requested and received your licenses prior to
your arrival to the class. If you have not received your licenses, the 3DEXPERIENCE platform will not work on
your laptop. It will not be possible to connect your laptop to the DS network in order to access the DS License
Server.

155
DS License server: Pre-Check

You should have already prepared the required details to proceed with this service installation, you will need the following pre-requisite: DS License file

You cannot proceed if this was not successful.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

156
DSLS: Key Parameters

Installation Cook-book: Installation key parameters explained.

Keywords: Licensing, DSLS, 4085/4084/4086, Cluster.

Installing from scratch: A risky operation usually only done if your DSLS database is corrupted and you have requested a new set of licenses. This
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

will leave the server in a standby mode.

Note: when uninstalling during a FP upgrade the DSLS database is not actually deleted (it’s a set of files). Those files remain on the system, this
is why it is not recommended to use special uninstallers (like Regclean) that also clean/delete registry entries and files that the normal uninstaller
would leave on the system.

Ports: The standard DSLS ports should be available on a standard OS. You will need to ensure that all platform servers can co mmunicate with the
Licensing port. The Admin port only needs to be accessible by the platform administrator, the platform servers will not use the Admin port.

157
3DEXPERIENCE platform: DSLS Installer

As we are using VMs, we will not install DSLS


but only demonstrate the installation.

The DSLS Installer is included in most of the GA media. If a FP is available you should use it instead, for this training we will use: DSLS-
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

V6R2023x.AllOS.zip

1. Go to “Your Installer PATH”, extract the file if not already done:


<Installers>\DSLS.AllOS\

2. Under the sub folders..\DSLS.AllOS\1 you will find: SetupDSLSmsi.exe

3. Using the Cheat-sheet on the next page execute the installer and proceed to the installation.

Note: The DSLS FP installers are not cumulative, implying that you don’t need to install the GA then the FP.
In a first installation situation you only need to install the FP, on a refresh you need to un-install the previous DSLS code then install the new DSLS FP.

30 minutes

158
DS License server: Configuration & Key Parameters

During the Installation you will be queried about the following parameters:

Cheat-Sheet :
Service Key Value
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

DSLS.00 Installer <Installers>\DSLS.AllOS\1\SetupDSLSmsi.exe

<Keep default value proposed>


DSLS.01 Installation Directory
C:\Program Files\Dassault Systemes\DS License Server\

Install Option Install License server and Administration Tool


DSLS.02
Install from scratch No
Optional Argument depending on certain Conditions
Enroll a license file Yes
DSLS.03 Administration Port 4084
Licensing Port 4085

The "Install from scratch option" is only used if your license database is corrupted or
you want to wipe the database license locks.
At the end of the installation, the license server details needs to be updated in DSLicSrv.txt
which is the default license file name located in C:\ProgramData\DassaultSystemes\Licenses

159
DS License server : Configuration & Key Parameters
Installer options recommended:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Recommended In special situations

160
DS License server: Administration Console

After the DSLS installation the Administration Panel will open. This is not the server itself, it is only the Administration tool that can be used to
connect to multiple License servers. The actual license server is a service running on your system, you use the Admin Console to connect to the
server.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The Server:

161
DS License server: FP Technical Validation

High level validation


Validate that the service is up and running, issues are mostly encountered during the installation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The DSLS is engineered to exist on a server class system, it is sensitive to actions that can
be considered hacking:
Can’t be installed in VM (DSLS in failover mode is supported on Windows Server 2016
virtualized in Hyper-V 2016 running on physical Windows Server 2016)
Changing the system clock
The server being down for more than 30 days
If anti-virus is running on the DSLS Server, de-activate scanning of the DSLS directories

The release level for DSLS must be at the same release level, or higher, as the installed
3DEXPERIENCE platform.

The DSLS FP installers are full installs, they do not require installing GA first.

162
DS License server: Post Configuration

These are the general configuration steps:

1. Connect to your DSLS using the Admin tool.


2. Enable your DSLS
3. Configure the DSLS Options
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Import your License file

163
DS License Server: Post Configuration

1. If no server appears in the panel, add one as per the screenshots below:
If you are inputting a FQDN and the text shows up as red it means that the name cannot be resolved.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. You should now see the following:


Double click on the server to activate it.

164
DS License Server: Post Configuration

3. You should now see the DSLS Configuration options.

4. The Status should be icon 


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The symbol indicates not yet connected.

165
DS License Server: Post Configuration

5. In this panel it is suggested to use the values shown.

6. You must also set a <DSLS Password>.

5. Then, click Apply then OK.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

166
DS License Server: Post Configuration

The final step is to import your LICZ license file.


a. Select your server
b. Select License > Enroll.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. The format and name of the LICZ file should be similar to this:

167
DS License Server: Post Configuration

d. You should receive a confirmation of the import.

e. In the administration tab you should see the imported licenses:

If you have multiple servers declared, be sure that you select the one that your platform will be using to ensure it will find the proper licenses.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

168
DS License Server: Uninstallation

Windows normal uninstall procedure:

 In Programs and Features uninstall:


o DS License server.
Note: You will also need to un-install if your are updating with a new FP.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

169
Exercise Recap: DSLS

1. In this exercise, you have:

 Installed DSLS
 Enrolled licenses
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

170
Global 3DEXPERIENCE platform Installer

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE Platform
3DEXPERIENCE platform: Global 3DEXPERIENCE platform Installer

The DS Installer is a set of installation tools used for installing server and client apps. The DS Installer is delivered on a separate media which you may
or may not need to use, depending on the app you are installing.

The global 3DEXPERIENCE platform Installer software is located in the following media:
AM_3DEXP_platform.AllOS under sub folder \1\
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The folder structure of the media is as follows: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 and 17
In general there will be two interactive installation executables:
Graphical User Interface (GUI)
Text User Interface (TUI)

It will be up to you to select the services that you wish to install on the current server. In the training you will proceed with the GUI installer and you
will install each component individually.

Even though it is possible to do a big bang installation by selecting all the services at the same time, we will not be cover ing this type of installation
during the training.

172
3DEXPERIENCE platform: Global 3DEXPERIENCE platform Installer

The installer is not a silent installer, it is only a broker simplifying the sequence of the normal installers. It will not s tore responses nor allow you to
batch install the modules.

The global installer is only available for GA core modules. It is not used for fix packs or client components.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

In this training you will be guided through the process using key values, there won’t be step-by-step screen shots. This will drive you to capture the
information and make the process your own.

For this training, the launcher will be used to call each individual services one by one.

The choice to use the embedded JDK and TomEE+ and a


few other options are asked for each component because
the installation of the 3DEXPERIENCE platform is
performed module by module.
If you perform a big-bang installation by selecting all
services, the installer will ask the questions for the first
service and use those answers for the remaining services.
This information was provided for education purpose, you
will not be installing all services at the same time.

173
3DEXPERIENCE platform: Media Installer Introduction
The Global 3DEXPERIENCE platform Installer:

Installation Choice Service Documentation


3DPassport Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
First Time - Installing Services One-by-One - 3DPassport - Installing 3DPassport
You MUST install 3DPassport before installing the other services, since it must be up and running prior to installing
some of the other services.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DDashboard Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
First Time - Installing Services One-by-One - 3DDashboard - Installing 3DDashboard
3DSearch Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
First Time - Installing Services One-by-One - 3DSearch – Installing 3DSearch

Install the services 3D Index Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
one-by-one Server First Time - Installing Services One-by-One - 3DSpace - 3DSpace Index – Installing 3DSpace Index
(using the individual service 3DSpace Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
installation media) Index First Time - Installing Services One-by-One - 3DSpace - 3DSpace Index – Installing 3DSpace Index
3DSpace Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
First Time - Installing Services One-by-One - 3DSpace - 3DSpace - Installing 3DSpace
3DComment Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
First Time - Installing Services One-by-One - 3DComment – Installing 3DComment
3DSwym Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
First Time - Installing Services One-by-One – Installing Cloudview, Installing 3DSwym Foundation, Installing
3DSwym Video Converter, Installing 3DSwym Index
3DNotification Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
First Time - Installing Services One-by-One – Installing 3DNotification
Install the services using the All services Installation and Setup - Install - 3DEXPERIENCE platform - Installing 3DEXPERIENCE platform Services for the
Global 3DEXPERIENCE First Time - Using the Global 3DEXPERIENCE platform Installer
platform Installer

174
3DPassport

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE platform
About 3DPassport

The 3DPassport service provides authentication and single sign-on (SSO) services for the whole 3DEXPERIENCE platform.

If your company already has an SSO system, 3DPassport can be configured as a replica to your enterprise solution, thus enabling SSO between
your enterprise solution and the 3DEXPERIENCE platform.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

There is no case in which an enterprise SSO solution can replace 3DPassport.

176
3DPassport Architecture
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

* Always Refer the "Program Directory" for version and latest news.

177
3DPassport: Pre-Check

You should have already prepared the required details to proceed with this service installation, you will need the following pre-requisites:

Database objects (up and running)

TomEE+ (stopped)
1 TomEE+ is dedicated for the service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1 SSL certificate
Java

You will not be able to proceed if any of these are missing.

Main Configuration requirements:


Database objects : Yes
TomEE+ needed : Yes
Java dependent : Yes

178
3DPassport: Key Parameters

Installation Cook-book: Installation key parameters explained.

Keywords: Security, User, Password, LDAP and Single Point of Authentication.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Installation Directory: This is the location where the service code will be installed. Do not use blanks in the installation path if you can avoid it. It is
also recommended not to install on the C:\ drive. The C:\drive is the system drive, if it gets corrupted or becomes full it could bring the service
down. By selecting another drive you will have better control and stability for the platform.

Installing Embedded JDK & Installing Embedded Apache TomEE+: 3DS service installer comes with java JDK and TomEE+. This can be practical
for small businesses and if you do not want to manage "other" software installations. The disadvantages are that it is harder to upgrade and
maintain Java security release and it cannot be easily implemented with load balancing.

Database selection: This component is supported on both Oracle and SQL Server. The database recommendation is often based on 2 critical
customer requirements, support and cost. It is important to note that the support costs can sometimes be higher than the actual license costs.

179
3DPassport: Key Parameters

The data repository is divided in 2 schemas / databases: 3DPassport and Token. 3DPassport contains the admin objects and user information
while Token contains the volatile session data. It’s not recommended to touch any of these tables without R&D support.

Mail options: This service is essential for password reset, there is no admin page allowing you to force a new password, this would be a very
big no-no in security. It is critical to be able to send mail, receiving replies is not required.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Application ports & Instance options: For the external TomEE+ instance be sure that you have the proper OS permissions as the application
may need to add, alter or update binaries, libraries or configuration files.

Forcing lowercase: This is up to the customer, it will make the platform user name mimic LDAP behavior which is usually case insensitive. By
Default 3DEXPERIENCE is case sensitive, it’s important to understand the customer requirements.

180
3DPassport: GA Media Installer

GA core components have two different installation methodologies:

The global 3DEXPERIENCE platform Installer found in:


<Media>\AM_3DEXP_Platform.AllOS\1\
Navigate to this path and find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

GUI: setup.exe
TUI: StartTUI.exe
This installer is primarily used when you want to deploy all the services on one machine

You will not be able to proceed if any of these are missing.


Graphical User Interface (GUI) : GUI is recommended for new releases.
Text User Interface (TUI)

Classic Service Installer are available in :


<Media>\AM_3DEXP_Platform.AllOS\1\3DPassport\Windows64\1
Traditional method used to deploy the services on different machines

Start the global 3DEXPERIENCE platform Installer for the training:


Fields to complete are identical for the two installers
Some of the parameters chosen with the initial service installer are presented in the subsequent installers as read -only

181
Exercise: 3DPassport

1. In this exercise, you will:

a. Install the GA 3DPassport


b. Perform the GA post configuration
c. Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validate the GA service

20 minutes

182
3DPassport - GA Media Installer

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select the "3DPassport Service" and click Next, then on the next window , click Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

183
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DPassport - GA Media Installer

2. Select "3DPassport Service" and click Install.

184
3DPassport - GA Media Installer

3. Using the Cheat-sheet on the next page proceed to the installation, don’t forget the installer options related to:
a. Installing the embedded JDK  No
b. Installing the embedded TomEE+  No
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

185
3DPassport: Key Parameters

During the Installation you will be queried about the following parameters:

Make sure to enter mytraining.com instead of mydomain. This


DNS is specific for this training and would vary in the real world.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Cheat-Sheet :

Steps Key Value

01 Installer <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe

02 Global platform Installer 3DPassport Service

03 Installation Directory D:\3DEXPERIENCE\R2023x\3DPassport

04 Install the embedded JDK No

05 JDK PATH D:\3DEXPERIENCE\Java64\jdk17

06 Install the embedded Apache TomEE+ No

07 Apache TomEE+ installation path D:\3DEXPERIENCE\TomEE\TomEE3DPassport

08 Force lowercase use's login No

09 DB Selection Oracle or SQL Server

186
3DPassport: Key Parameters

During the Installation you will be queried about the following parameters:
Cheat-Sheet :
Steps Key Value

C:\app\dbadmin\network\admin
The tnsnames.ora can be skipped. Instead the following can be
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Directory tnsnames.ora
used:
//database.mytraining.com:1521/X3DEXP.mytraining.com

Net_Service_ name for 3DPassport X3DEXP

Net_Service_ name for 3DPassport


X3DEXP
10 token
Oracle
Database username X3DPASSADMIN

Database user's password X3DPASSADMIN

Token username X3DPASSTOKENS

Token user's password X3DPASSTOKENS

Check database connection Yes

Database Host database.mytraining.com\X3DEXP:1433

Database name x3dpassdb

10 Database Administrator username x3dpassadmin


SQL Server Database Administrator user's password Passport#1

Database username x3dpass

Database user's password Passport#1


187
3DPassport: Key Parameters

Additional parameters you will be queried about during the installation:


Cheat-Sheet :

Service Key Value

Token Database name database.mytraining.com\X3DEXP:1433


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Token database name x3dpasstkdb


10
Token Database username x3dpasstokens
SQL Server
Token Database user's password Passport#1

Check database connection Yes

Administrator mail [email protected]


11
Administrator password Zaq1@WsxCde3

3DPassport service URL https://3dpassport.mytraining.com:443/3dpassport


12
3DCompass service URL https://3dspace.mytraining.com:443/3dspace

Mail Server name smtp.mytraining.com


13
Mail sender name [email protected]

188
3DPassport: GA Media Installer – Oracle Summary

It is strongly recommended that you copy the installation information into a text file prior to clicking the Install button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

189
3DPassport: GA Media Installer – SQL Server Summary

1. It is strongly recommended that you copy the installation information into a text file prior to clicking the Install button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

190
3DPassport: GA Media Installer – End Of Installation

1. Click OK when you get the “Installation of Runtime VC14 x86 succeeded” pop up message. Also remember to close all installation windows
once installation is complete. In short, there should not be any 3DEXPERIENCE icon present in the taskbar at the bottom of the screen.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

191
3DPassport: GA Post Installation

3Dpassport installer does not immediately create the database objects, these objects are created during application startup. You will notice messages
in the TomEE+ logs about database tables already existing upon re-start of TomEE+.
The installer automatically puts the TomEE+ WAR file in the proper webapps folder.

a. TomEE+ code PATH: D:\3DEXPERIENCE\TomEE\TomEE3DPassport


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Start and stop TomEE+ (or use your Desktop icon) You may need to repeat
<TomEE3DPassport>\bin\startup.bat this step in order to get a
proper Server startup
Wait for it to finish deploying the application.
message.

<TomEE3DPassport>\bin\shutdown.bat
Wait for it to finish shutting down before closing the terminal.

c. Check the logs for any errors and delete the logs in the folder
<TomEE3DPassport>\logs\*.log

192
3DPassport: GA Post Installation

d. Go to your 3DEXPERIENCE folder and edit the file: D:\3DEXPERIENCE\conf\3dexperience.conf In the 3DPassport section replace the line:
#XXXX Future fragment file XXXX
With:
include D:\3DEXPERIENCE\R2023x\3DPassport\win_b64\templates\3DPassport_httpd_fragment.conf
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

e. Edit the fragment file:


D:\3DEXPERIENCE\R2023x\3DPassport\win_b64\templates\3DPassport_httpd_fragment.conf
Update the values for "port" and "FQDN" are correct in the fragment.
http://3dpassport.mytraining.com:8080/3dpassport

f. Make a backup of the fragment file named:


D:\3DEXPERIENCE\conf\fragment\3DPassport_httpd_fragment.conf.GA

g. Copy "UserIntentions_CODE.xml" file found in:


D:\3DEXPERIENCE\R2023x\3DPassport\InstallData
To folder: D:\3DEXPERIENCE\conf\UserIntentions\
and rename it to: UserIntentions_3DPassport.xml
193
3DPassport: GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.
There are 2 validation steps: installer log and expected file deployment review.
Code Installation Path <Code Path> = D:\3DEXPERIENCE\R2023x\3DPassport
1. Installer error log should be 0 bytes and can be found at:
<Code>\InstallData\log\...media<Latest timestamp>\Errors.log & *Stderr.txt
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Size should be 0 bytes


If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages require
corrective action.

2. Expected file and/or folder creation:


a. <TomEE 3DPassport>\webapps\3dpassport.war
b. <TomEE 3DPassport>\bin\setenv.bat
Verify if the installer have updated the setenv.bat file

194
3DPassport: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. 3DPassport TomEE+
1. Restart the "Apache2.4" Service
a. Open service manager
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Start TomEE+ Each time you test a new URL


a. <TomEE 3DPassport>\bin\startup.bat bookmark it in Firefox.
b. Access the MyURLs.html or
https://3dpassport.mytraining.com:443/3dpassport MyURLs.html

195
3DPassport: Validation

3. Perform the following actions: Connect to 3Dpassport

a. Connect with user admin_platform and password Zaq1@WsxCde3


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. You can click Log out.

196
Exercise Recap: 3DPassport

1. In this exercise, you have:

 Installed the GA 3DPassport


 Performed the GA post configuration
 Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Validated the GA service

197
Reconfiguration

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE Platform
About Reconfiguration

The reconfiguration tool allows you to tweak certain service installation and deployment parameters, avoiding the need to rei nstall the platform.

Administrators often need to change certain values, for example passwords and URLs, after the installation is finished.

Reconfigure mode allows you to make these changes without having to re-install platform services from scratch.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This mode starts the installation procedure again, allowing you to reconfigure inputs for the supported parameters. If a para meter is not
reconfigurable, it is either hidden or greyed out.

You can change values even after installing the latest hot fixes. In this case, you must use the hot fix media to reconfigure the service.

The following services can be reconfigured:


3DPassport.
3DDashboard As you use are using the external TomEE+ in this training, you must stop
the application server before starting reconfiguration.
3DSearch
Reconfiguring does not allow you to switch between external Java and/or
3DSpace
external TomEE+ to embedded mode or vice versa or to change the
3DComment installation path.
3DNotification To save time, you can also manually stop the TomEE+ server before
3DSwym starting the reconfiguration.
File Collaboration Server

199
Exercise: Reconfiguration

As we have successfully installed the 3DPassport service, we are not reconfiguring it now.

Here, are the steps to perform reconfiguration, if required.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

In this exercise, you can reconfigure the 3DPassport service.

10 minutes

200
Exercise: 3DPassport - Reconfiguration

1. Open a command prompt window with administrator privileges.


2. Change to the distribution directory to
<Installers>\3DPassport.Windows64\1
3. Execute the command:
Setup.exe --reconfig for GUI mode
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

or
StartTUI.exe --reconfig for TUI mode.

4. The installation procedure then starts.

201
3DPassport: Reconfiguration

During the Installation you will be queried about the following parameters:

Cheat-Sheet :

Step Key Value


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

00 Global platform Installer <Media>\AM_3DEXP_platform.AllOS\1\setup.exe --reconfig

202
3DPassport: Reconfiguration Parameters

During the Installation you will be queried about the corresponding reconfigurable parameters with respect to a service.
For example, below the reconfigurable parameters for 3DPassport are illustrated:

Cheat-Sheet :
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Value to be
Steps Key Value Displayed
reconfigured

01 JDK PATH D:\3DEXPERIENCE\Java64\jdk17 *UNCHANGED*

02 Apache TomEE+ Installation path D:\3DEXPERIENCE\TomEE\TomEE3DPassport *UNCHANGED*

3DPassport service URL https://3dpassport.mytraining.com:443/3dpassport


03 *UNCHANGED*
3DCompass service URL https://3dspace.mytraining.com:443/3dspace

Mail Server name smtp.mytraining.com *UNCHANGED*


04
Mail sender name [email protected] [email protected]

05 JDK PATH D:\3DEXPERIENCE\Java64\jdk17 *UNCHANGED*

06 Apache TomEE+ Installation path D:\3DEXPERIENCE\TomEE\TomEE3DPassport *UNCHANGED*

203
3DPassport: Reconfiguration Parameters

During the Installation you will be queried about the following reconfigurable parameters:

Cheat-Sheet :

Value to be
Steps Key Value Displayed
reconfigured
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Directory tnsnames.ora C:\app\dbadmin\network\admin

Net_Service_ name for 3DPassport X3DEXP

Net_Service_ name for 3DPassport token X3DEXP

Database username X3DPASSADMIN


07 *UNCHANGED
Oracle *
Database user's password *blank*

Token username X3DPASSTOKENS

Token user's password *blank*

Check database connection Yes

204
3DPassport: Reconfiguration Parameters

During the Installation you will be queried about the following reconfigurable parameters:

Cheat-Sheet :

Value to be
Steps Key Value Displayed
reconfigured
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Database Host database.mytraining.com\X3DEXP:1433

Database name passdb

Database Administrator username x3dpassadmin

Database Administrator user's password *blank*

Database username x3dpass


SQL
Database user's password *blank* *UNCHANGED*
Server

Token Database name database.mytraining.com\X3DEXP:1433

Token Database name passtkdb

Token Database username x3dpasstokens

Token Database user's password *blank*

Check Database connection Yes

205
3DPassport: Reconfiguration Validation

1. The previous values for the parameters are already specified, except passwords

2. Modify the reconfigurable parameters you need to change

3. Review your configuration parameters and click the Reconfigure > button
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Once the reconfiguration is complete, the following message is displayed:


The installation program has finished reconfiguring 3DEXPERIENCE R2023x on your computer

5. Click the Close button to exit

You can verify the installation logs here:


1. install_dir\InstallData\log\<timestamp>_CODE_win_b64_X3D_PASS.media\ on Windows

206
3DPassport: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. 3DPassport TomEE+
1. Restart the "Apache2.4" Service
a. Open service manager
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Start TomEE+
a. <TomEE 3DPassport>\bin\startup.bat Each time you test a new URL
bookmark it in Firefox.
b. Access the MyURLs.html or
https://3dpassport.mytraining.com:443/3dpassport
MyURLs.html

207
3DPassport: Validation

Perform the following actions: Connect to 3Dpassport

a. Connect with user admin_platform and password Zaq1@WsxCde3


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

208
Exercise Recap: Reconfiguration

1. In this exercise, you have:

 Reconfigured the 3DPassport service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

209
3DPassport: Uninstallation

Windows normal uninstall procedure:

Stop TomEE+ if it is running <Service Name>

In the Database instance drop the 2 schemas / databases.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

In "Programs and Features" uninstall:


"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

Or the Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

Remove the folders:


D:\3DEXPERIENCE\R2023x\<Service Name>
D:\3DEXPERIENCE\TomEE\TomEE<Service Name>

210
3DDashboard

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE Platform
About 3DDashboard
The 3DDashboard service brings information from diverse sources into one customizable web page which can be shared with any platform
members.

It provides a simple, unified dashboard view of business processes and objectives for any discipline in the company (sales, m arketing, R&D,
HR, finance,… or yourself as an individual).
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

It provides an extensive collection of ready-to-use 3DDashboard widgets across all brands so that it is even easier for users to create a
personal dashboard of all the information that matters to them and get a simple unified view of business processes.

212
3DDashboard Architecture
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

* Always Refer the "Program Directory" for version and latest news.

213
3DDashboard: Pre-Check

You should have already prepared the required details to proceed with this service installation, you will need the following pre-requisites:

Database objects (up and running)

TomEE+ (stopped)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1 TomEE+ is dedicated for the service


1 SSL certificate

Java

Note: You will not be able to proceed if any of these are missing.

Main Configuration requirement:


Database objects : Yes
TomEE+ needed : Yes
Java dependent : Yes

214
3DDashboard: Key Parameters

Installation Cook-book : Installation key parameters explained.

Keywords: User administration for admin_platform.

Installation Directory: This is the location where the service code will be installed. Do not use blanks in the installation path if you can avoid it. It is
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

also recommended not to install on the C:\ drive. The C:\ drive is the system drive, if it gets corrupted or becomes full it could bring the service
down. By selecting another drive you will have better control and stability for the platform.

Installing Embedded JDK & Installing Embedded Apache TomEE+: 3DS service installer comes with java "JDK" and TomEE+. This canbe practical
for small businesses and if you do not want to manage "other" software installations. The disadvantages are that it is harder to upgrade and
maintain Java security release and it cannot be easily implemented with load balancing.

215
3DDashboard: Key Parameters

Database selection: This component is supported on both Oracle and SQL Server. The database recommendation is often based on two critical
customer requirements, support and cost. It is important to note that the support costs can sometimes be higher than the actual license costs.

Mail options: Not as critical as the 3Dpassport one but very important, it’s from the 3DDashboard you can invite user to the platform and it’s from
here the platform admin will receive mail of user requesting roles and access.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Application ports & Instance options: For the external TomEE+ instance be sure that you have the proper OS permissions as the application may
need to add, alter or update binaries, libraries or configuration files.

3DEXPERIENCE platform requires two distinct 3DDashboard FQDN as listener, prior to installation:
the trusted FQDN authenticated services of the 3DEXPERIENCE platform and
the not trusted FQDN which prevents by design, a widget to use the authenticated services of the 3DEXPERIENCE platform.
Trusted domain cannot be a sub-domain of untrusted domain.

216
3DDashboard: GA Media Installer

GA core components have two different installation methodologies:

The "global 3DEXPERIENCE platform Installer" found in:


<Media>\AM_3DEXP_Platform.AllOS\1\
Navigate to this path and find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

o GUI: setup.exe
o TUI: StartTUI.exe
This installer is primarily used when you want to deploy all the services on one machine

Classic "Service Installer" are available in :


<Media>\AM_3DEXP_Platform.AllOS\1\3DDashboard\Windows64\1
Traditional method used to deploy the services on different machines

Start the "global 3DEXPERIENCE platform Installer" installer for the training
Fields to complete are identical for the two installers
Some of the parameters chosen with the initial service installer are presented in the subsequent installers as read -only
This installer is useful when you deploy many services on one machine

217
Exercise: 3DDashboard

1. In this exercise, you will:

a. Install the GA 3DDashboard


b. Perform the GA post configuration
c. Technical validation of the GA service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validate the GA service

20 minutes

218
3DDashboard: GA Media Installer

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select the "3DDashboard Service" and click Next, then on the next window , click Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

219
3DDashboard: Key Parameters

3. Using the Cheat-sheet on the next page, proceed to the installation, don’t forget to uncheck the installer options for:
i. Install the embedded JDK  No
ii. Install the embedded TomEE+  No
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

220
3DDashboard: Key Parameters

During the Installation you will be queried about the following parameters:

Cheat-Sheet :
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Steps Key Value

01 Installer <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe

02 Global platform Installer 3DDashboard Service

03 Installation Directory D:\3DEXPERIENCE\R2023x\3DDashboard

04 Install the embedded JDK No

05 JDK PATH D:\3DEXPERIENCE\Java64\jdk17

06 Install the embedded Apache TomEE+ No

07 Apache TomEE+ installation path D:\3DEXPERIENCE\TomEE\TomEE3DDashboard

08 DB Selection Oracle or SQL Server

221
3DDashboard: Key Parameters

(continued)
Make sure to enter mytraining.com instead of mydomain . This
DNS is specific for this training and would vary in the real world.

Steps Key Value


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Directory of tnsnames.ora C:\app\dbadmin\network\admin

Net_Service_Net name for 3DDashboard X3DEXP


09
Oracle
Database username X3DDASHADMIN

Database user's password X3DDASHADMIN

Database Host database.mytraining.com\X3DEXP:1433

Database name x3ddashdb

Database Administrator username x3ddashadmin


SQL
server Database Administrator user's password Passport#1

Database username x3ddash

Database user's password Passport#1

222
3DDashboard: Key Parameters

You will also be queried about these parameters:

Cheat-Sheet : (continued)

Steps Key Value


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DPassport service URL https://3dpassport.mytraining.com:443/3dpassport

3DDashboard service URL https://3ddashboard.mytraining.com:443/3ddashboard


10
3DCompass service URL https://3dspace.mytraining.com:443/3dspace

6WTag service URL https://3dspace.mytraining.com:443/3dspace

Mail Server name smtp.mytraining.com


11
Mail sender name [email protected]

Domain to use for external Widgets untrusted.mytraining.com

12 Allow WebAPI for following domains .*

Shared directory D:\3DEXPERIENCE\data\3DDashboardData

223
3DDashboard: GA Media Installer – Oracle Summary

It is strongly recommended that you copy the installation information into a text file prior to clicking the "install" button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

224
3DDashboard: GA Media Installer – SQL Server Summary

It is strongly recommended that you copy the installation information into a text file prior to clicking the "install" button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

225
3DDashboard: GA Media Installer – End Of Installation

1. Click OK when you get the “Installation of Runtime VC14 x86 succeeded” and “Installation of Runtime VC14 x64 succeeded” pop up
message. Also remember to close all installation windows once installation is complete. In short, there should not be any 3DEXPERIENCE icon
present in the taskbar at the bottom of the screen.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

226
3DDashboard: GA Post Installation

3DDashboard installer creates the database objects during the installer, they can be immediately validated.

TomEE+ code PATH: D:\3DEXPERIENCE\TomEE\TomEE3DDashboard

The installer will automatically put the .WAR file into the proper webapps folder.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

You may need to repeat


b. Start and stop TomEE+ (or use you Desktop icon)
this step in order to get a
<TomEE 3DDashboard>\bin\startup.bat proper Server startup
Wait for it to finish deploying the application. message.

<TomEE 3DDashboard>\bin\shutdown.bat
Wait for it to finish shutting down before closing the terminal.

c. Check the logs for errors and Clean the log folder
<TomEE 3DDashboard>\logs\*.log

227
3DDashboard: GA Post Installation

d. Go to your 3DEXPERIENCE folder and edit the file: D:\3DEXPERIENCE\conf\3dexperience.conf


In the "3DDashboard" section replace the line:
#XXXX Future fragment file XXXX
With:
include D:\3DEXPERIENCE\R2023x\3DDashboard\win_b64\templates\3DDashboard_httpd_fragment.conf
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

e. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\3DDashboard\win_b64\templates\3DDashboard_httpd_fragment.conf
Update the values of the "port" and "FQDN" in the fragment file: http://3ddashboard.mytraining.com:8180/3ddashboard

f. Backup the fragment file to:


D:\3DEXPERIENCE\conf\Fragment\3DDashboard_httpd_fragment.conf.GA
g. Copy the "UserIntentions_CODE.xml" file in folder
D:\3DEXPERIENCE\R2023x\3DDashboard\InstallData
To: D:\3DEXPERIENCE\conf\UserIntentions\
Rename it to: UserIntentions_3DDashboard.xml

228
3DDashboard: GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.
There are 2 validation steps: installer log and expected file deployment review.
Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DDashboard
1. Installer error log should be 0 bytes and can be found at :
<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_DASH.media\Errors.log & *Stderr.txt
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Size should be 0 bytes


If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

2. Expected file and/or folder creation:


a. <TomEE 3DDashboard>\webapps\3ddashboard.war
b. <TomEE 3DDashboard>\bin\setenv.bat

229
3DDashboard: Validation

1. In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. Redirect to 3DDashboard TomEE+ after Passport Authentication
2. Restart the "Apache2.4" Service
a. Open service manager
3. Start TomEE+
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. <TomEE 3DDashboard>\bin\startup.bat
4. Access the MyURLs.html or
https://3ddashboard.mytraining.com:443/3ddashboard
Each time you test a new URL
bookmark it in Firefox.
5. 3DDashboard depends on 3DSpace which is not yet installed, the expected behavior is
a. 3DDashboard redirects to 3DPassport via Apache
b. After 3DPassport authentication, redirected back to "3DDashboard" via Apache resulting in error "Sorry Access denied. You don't have access
to this 3DEXPERIENCE platform".

MyURLs.html

230
Exercise Recap: 3DDashboard

1. In this exercise, you have:

 Installed the GA 3DDashboard


 Performed the GA post configuration
 Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Validated the GA service

231
3DDashboard: Uninstallation

Windows normal uninstall procedure:

Stop TomEE+ that if it is running <Service Name>

In the Database instance you must drop the user/database.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

In "Programs and Features" uninstall:


"Dassault Systemes <Service Name>3DEXPERIENCE R2023x"

Or the Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

Remove the folders:


D:\3DEXPERIENCE\R2023x\<Service Name>
D:\3DEXPERIENCE\TomEE\TomEE<Service Name>

232
3DSearch

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE Platform
About 3DSearch

3DSearch is the front-end search service used by 3DEXPERIENCE platform users to get search results coming from 3DSpace and 3DSwym
sources.

Dispatch the 3DSearch requests to the different Data Sources requested.

Merge the results in a single message while keeping the security of individual sources.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

234
3DSearch : Architecture
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

* Always Refer the "Program Directory" for version and latest news.

235
3DSearch : Pre-Check

You should have already prepared the required details to proceed with this service installation, you will need the following pre-requisites:

TomEE+ (stopped)
1 TomEE+ is dedicated for the service
1 SSL certificate
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Java

Note: You will not be able to proceed if any of these are missing.

Main Configuration requirement:


TomEE+ needed : Yes
Java dependent : Yes

236
3DSearch : Key Parameters

Installation Cook-book: Installation key parameters explained.

Keywords: 3DSearch for 3DSwym and 3DSpace.

Installation Directory: This is the location where the service code will be installed. Do not use blanks in the installation path if you can avoid it. It is
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

also recommended not to install on the C: drive. The C: drive is the system drive, if it gets corrupted or becomes full it could bring the service
down. By selecting another drive you will have better control and stability for the platform.

Installing Embedded JDK & Installing Embedded Apache TomEE+: 3DS service installer comes with java JDK and TomEE+. This can be practical
for small businesses and if you do not want to manage other software installations. The disadvantages are that it is harder to upgrade and maintain
Java security release and it cannot be easily implemented with load balancing.

Application server path option: For the external TomEE+ instance be sure that you have the proper OS permissions as the appli cation may need to
add, alter or update binaries, libraries or configuration files.

237
3DSearch: GA media installer

GA core components have two different installation methodologies:

The global 3DEXPERIENCE platform Installer found in:


<Media>\AM_3DEXP_Platform.AllOS\1\
Navigate to this path and find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

GUI: setup.exe
TUI: StartTUI.exe
This installer is primarily used when you want to deploy all the services on one machine

Classic "Service Installer" are available in :


<Media>\AM_3DEXP_Platform.AllOS\1\FederatedSearchFoundation\Windows64\1
Traditional method used to deploy the services on different machines

Start the GUI installer

238
Exercise: 3DSearch (Federated Search Foundation)

In this exercise, you will:

a. Install the GA 3DSearch


b. Perform the GA post configuration
c. Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validate the GA service

20 minutes

239
3DSearch: GA media installer

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select "FederatedSearchFoundation" and click install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

240
3DSearch: Key Parameters

3. Using the Cheat-sheet on the next page, proceed to the installation, don’t forget to uncheck the installer options for:
a. Install the embedded JDK  No
b. Install the embedded TomEE+  No
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

241
3DSearch: Key Parameters

During the Installation you will be queried about the following parameters:

Cheat-Sheet : Make sure to enter mytraining.com instead of mydomain. This


DNS is specific for this training and would vary in the real world.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Steps Key Value

01 Installer <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe

02 Global platform Installer FederatedSearchFoundation

03 Installation Directory D:\3DEXPERIENCE\R2023x\FedSearch

04 Install the embedded JDK No

05 JDK PATH D:\3DEXPERIENCE\Java64\jdk17

06 Install the embedded Apache TomEE+ No

07 Application server installation path D:\3DEXPERIENCE\TomEE\TomEEFedSearch

3DPassport service URL https://3dpassport.mytraining.com:443/3dpassport


Federated Searchservice URL https://3dsearch.mytraining.com:443/federated
08
3DSpace service URL https://3dspace.mytraining.com:443/3dspace
3DSWYM service URL https://3dswym.mytraining.com:443/3dswym

242
3DSearch: GA Media Installer

1. It is strongly recommended that you copy the installation information into a text file prior to clicking the "install" button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

243
3DSearch: GA Post Installation

3DSearch does not connect to a database or create database objects. A clean startup of TomEE+ is required after installation.

a. TomEE+ code PATH: D:\3DEXPERIENCE\TomEE\TomEEFedSearch

b. Start and stop TomEE+ (or use you Desktop icon)


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<TomEE FedSearch>\bin\startup.bat
Wait for it to finish deploying the application.

<TomEE FedSearch>\bin\shutdown.bat
Wait for it to finish closing properly the terminal …

c. Check the logs for errors then delete the logs in the log folder
o <TomEE FedSearch>\logs\*.log

244
3DSearch: GA Post Installation

d. Go to your 3DEXPERIENCE folder and edit the file:


D:\3DEXPERIENCE\conf\3dexperience.conf
In the section " 3DSearch" replacing the following line:
#XXXX Future fragment file XXXX
With:
include D:\3DEXPERIENCE\R2023x\FedSearch\win_b64\templates\federated_httpd_fragment.conf
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

e. Edit the fragment file : D:\3DEXPERIENCE\R2023x\FedSearch\win_b64\templates\federated_httpd_fragment.conf


Update the values for "port" and "FQDN" in the fragment file: http://3dsearch.mytraining.com:8280/federated

f. Backup the fragment file to :


D:\3DEXPERIENCE\conf\Fragment\federated_httpd_fragment.conf.GA

g. Copy the "UserIntentions_CODE.xml" file in folder


D:\3DEXPERIENCE\R2023x\FedSearch\InstallData
To folder: D:\3DEXPERIENCE\conf\UserIntentions\
and rename to UserIntentions_FedSearch.xml

245
3DSearch: GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do. There are
two steps: installer log and expected file deployment review.
Defining the service code installation path: D:\3DEXPERIENCE\R2023x\FedSearch
1. Installer error log should be 0 bytes and can be found at:
<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_SEAR.media\Errors.log & *Stderr.txt
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Size should be 0 bytes


If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages require
corrective action.

2. Expected file creation, and folder :


a. <TomEE FedSearch>\webapps\federated.war
b. <TomEE FedSearch>\bin\setenv.bat

246
3DSearch: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. Redirect to 3DSearch after 3DPassport authentication

1. Restart the "Apache2.4" Service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

2. Start TomEE+
Each time you test a new URL
a. <TomEE 3DPassport>\bin\startup.bat
bookmark it in Firefox.
b. <TomEE FedSearch>\bin\startup.bat
Wait for it to finish deploying the application.
Access MyURLs.html or https://3dsearch.mytraining.com:443/federated

MyURLs.html

3DSearch has no user interface, the expected behavior is:


HTTPS URL access
Apache Found the URL
Redirected by Federated to 3DPassport via Apache
Federated App found and proper redirection to 3DPassport
Redirected back by 3DPassport to "federated" via Apache resulting in page not found (404 error).
Proper redirection from 3DPassport back to the Application

247
Exercise Recap: 3DSearch

1. In this exercise, you have:

 Installed the GA 3DSearch


 Performed the GA post configuration
 Technical validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Validated the GA service

248
3DSearch: Uninstallation

Windows normal uninstall procedure:

Stop TomEE+ if it is running <Service Name>

In "Programs and Features" uninstall:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

Or the Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

c. Remove the folders:


D:\3DEXPERIENCE\R2023x\<Service Name>
D:\3DEXPERIENCE\TomEE\TomEE<Service Name>

249
3DSpaceIndex

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE Platform
About 3DSpace Index

3DSpace Index Server is used as the search engine for all products.
3DSpace Index (Previously known as Exalead Full text Search) is based on EXALEAD CloudView technology, it is an independent s erver with
specific Program Directory requirements.
The server needs a continuous range of 100 TCP ports to operate correctly. By default, 3DSpace Index Server executes on a port range of 19000-
19100. If any other applications are using any of the ports between 19000 and 19100, it will result in the server being unable to start/restart.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DSpace Index Search server handles its own stored and indexed data, and can only be used by 3DEXPERIENCE platform apps or developed
using 3DEXPERIENCE platform public APIs. It should not be confused with other EXALEAD CloudView products.

251
3DSpace Index: Architecture

The end users never access the 3DSpace Index server directly. Only the Administrator will need access to the server backend. The administration
URL should be protected via firewall rules.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Push API Search API

Batch
Consolidation
ENOVIA DB Search Client
MQL Client 3DSpace (ENOVIA/CATIA/DELMIA)

Analyzer

Map
Index
ENOVIA FCS Servers +
SXI Converter

Administration Gateway
Indexing (Build time)
Management API Searching( Run time)

Administration
Administration
Console

252
3DSpace Index: Pre-Check

3DSpace Index is not a "typical" DS core component installation, this requires you to pay particular attention to the "Program Directory" and
documentation.

Program Directory
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Documentation

253
3DSpace Index: Key Parameters

Installation Cook-book: Installation key parameter explained.

Keywords: Metadata and text file indexation.

Installation Directory: This is Where the service code will be installed. Do not use blanks in the installation path if you c an avoid it. It is also
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

recommended not to install on the C: drive. The C: drive is the system drive, if it gets corrupted or becomes full it could bring the service
down. By selecting another drive you will have better control and stability for the platform.

Search service URL: It is very Important to validate that the "search" ports are free, these ports need to be reached by the 3DEXPERIENCE
platform administrator and 3DSpace server.

Number of Slices & Number of Analyzers: These are performance parameters specific to the size of the data and hardware. If yo ur
implementation is "3DSpace Index" heavy, it’s recommended to consult the documentation and potentially an 3DSpace Index specialist.
3DSpace Index server performs a lot of functions, it is an index, an application server, a data builder, a file scanner and handles user requests
for data.

Search Server Data Path: Is the location where the 3DSpace Index will store all its indexes, it is important that this locati on execute on fast,
secure disk (SSD or RAID). If using external storage, be sure that it’s fast and extremely low latency. Fast Network cards (NICs) are also
recommended as the 3DSpace Index will transfer a lot of data between the database and 3DSpace!

254
3DSpace Index : Key Parameters

Main Configuration requirement:


Database objects : No
TomEE+ needed : No
Java dependent : No

3DSpace Index installation "custom options" are based on the target server:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Single Search Server


HA Main Server
HA Secondary Server
File Converter Only
Simple installations assume a “main" configuration only

255
3DSpace Index : Key Parameters

About:
Single server Option:
Single Search Server, this is the most common option for small business, development and OOTB environments.

High Availability option:


Advanced configuration and systems that require High Availability.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

HA Main Server
HA Secondary Server

FCS Option:
File Converter Only
Essential component that needs to be installed with each FCS host.
In a production situation when installing additional FCSs, you would install the File Converter also.

Typically you would install the File Converter component on any machine running FCS. In the training we have one FCS installed. Since we are doing
an all-in-one install you will not need to install the File Converter component because the Single Search Server option already has the File Converter
code built into it. This is a special case because of the training format.

256
3DSpace Index: GA Media Installer

GA core components have two different installation methodologies:

The "global 3DEXPERIENCE platform Installer" found in:


<Media>\AM_3DEXP_platform.AllOS\1\
Navigate to this path and find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

o GUI: setup.exe
o TUI: StartTUI.exe

Classic Service Installer are available in :


<Media>\AM_3DEXP_Platform.AllOS\1\3DSpaceIndex\Windows64\1

Start the GUI installer according to your preference

257
Exercise: 3DSpace Index

1. In this exercise, you will:

a. Install the GA 3DSpace Index


b. Perform the GA post configuration
c. Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validate the GA service

20 minutes

258
Exercise: 3DSpace Index - GA Media Installer

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select "3DSpace Index" and click install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

259
Exercise: 3DSpace Index - GA Media Installer

1. Using the Cheat-sheet on the next page, proceed to the installation, don’t forget the installer option related to:
a. Installation mode  "Custom"
b. Installation type  "Single Search Server"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

260
3DSpace Index : Key Parameters

During the Installation you will be queried about the following parameters:

The set of parameters may look simple but this service is very quick and powerful. Advanced configuration is done via the administration GUI.

Make sure to enter mytraining.com instead of mydomain. This


Cheat-Sheet : DNS is specific for this training and would vary in the real world.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Steps Key Value

01 Global platform Installer <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe

02 Global platform Installer 3DSpace Index

03 Installation Directory D:\3DEXPERIENCE\R2023x\3DSpaceIndex

04 Installation mode Custom

05 Installation type Single Search Sever

Search service URL http://3dspaceindex.mytraining.com:19000


Number of Slices 1
06
Number of Analyzers 1
Admin Password Zaq1@WsxCde3

07 Search Server Data Path D:\3DEXPERIENCE\data\3DSpaceIndex\cv\data

261
3DSpace Index: GA Media Installer

It is strongly recommended that you copy the installation information into a text file prior to clicking the "install" button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

You may see message of VC++ installation as popup during the installation. Choose Yes and proceed with the installation.

262
3DSpace Index: GA Media Installer

During the installation you maybe required to install a specific Visual C++ package if it does not already exist on your system.

This can pop-up a few times! Say Yes to all, and give it a bit of time.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

263
3DSpace Index: GA Post Installation

You will notice the 3DSpace Index installer is quite different, as a result, 3DSpace Index does not require much for post installation procedures.

a. Copy the "UserIntentions_CODE.xml" file in folder


D:\3DEXPERIENCE\R2023x\3DSpaceIndex\InstallData
To:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

D:\3DEXPERIENCE\conf\UserIntentions\
and rename it to: UserIntentions_3DSpace Index.xml

3DSpace Index does have additional Post installation activities such as


updating the "config.xml" file and checking or changing the scheduler jobs.
You will not be performing these tasks at this time. It is more efficient to cover
those activities after all core components, centrals and FPs are installed.

264
3DSpace Index: GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do. There are
two steps: installer log and expected file deployment review.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DSpaceIndex


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. Installer error log should be 0 bytes and can be found at:


<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_ENOVIA_SXI.media\Errors.log & *Stderr.txt
Size should be 0 bytes

If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages require
corrective action.

2. An 3DSpace Index service should be running, if it is not running you will need to consult:
"Computer Manager" + "Event Viewer" + "Windows Logs"

265
3DSpace Index: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
Service
Access to the Administration page
1. Start the 3DSpaceIndex service if not already running
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Access the MyURLs.html or http://3dspaceindex.mytraining.com:19001/index.html


Each time you test a
new URL bookmark
it in Firefox.

MyURLs.html

266
3DSpace Index: Validation

3. In the web page select the Administration console.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Connect with user admin, password: Zaq1@WsxCde3


You should see:

We need to fix the license expired message by following this QA article:


https://kb.dsxclient.3ds.com/mashup-ui/page/document?q=docid:QA00000041600

267
Exercise Recap: 3DSpace Index

1. In this exercise, you have:

 Installed the GA 3DSpace Index


 Performed the GA post configuration
 Validated the GA service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

268
3DSpace Index: Uninstallation

Windows normal uninstall procedure:

Stop the Services and Scheduled Task job

In "Programs and Features" uninstall:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

Or the Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

c. Remove the folder:


D:\3DEXPERIENCE\R2023x\<Service Name>

269
3DSpace

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE Platform
About 3DSpace

3DSpace is the core of the 3DEXPERIENCE platform.

The 3DSpace installer allows you to install all 3DSpace component and deploy the server or upgrade an existing installation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

271
3DSpace : Architecture
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

* Always Refer the "Program Directory" for version and latest news.

272
3DSpace: Pre-Check

You should have already prepared the required details to proceed with this service installation, you will need the following pre-requisites:

Database objects (up and running)

TomEE+ (stopped)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2 TomEE+ are dedicated for this service


2 SSL certificates

Java

Note: You will not be able to proceed if any of these are missing.

Main Configuration requirement:


Database objects : Yes
TomEE+ needed : Yes
Java dependent : Yes

273
3DSpace: Key Parameters

Installation Cook-book: Installation key parameter explained.

Keywords: Local 3DSpace user password, Central repository of the metadata, platform management service.

Installation Directory: This is the location where the service code will be installed. Do not use blanks in the installation path if you can avoid it. It is
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

also recommended not to install on the C: drive. The C:drive is the system drive, if it gets corrupted or becomes full it could bring the service down.
By selecting another drive you will have better control and stability for the platform.

Installing Embedded JDK & Installing Embedded Apache TomEE+: 3DS service installer comes with java JDK and TomEE+. This can be practical
for small businesses and if you do not want to manage other software installations. The disadvantages are that it is harder to upgrade and maintain
Java security release and it cannot be easily implemented with load balancing.

Database selection: This component supports both Oracle and SQL Server. The database recommendation is often based on two cri tical customer
requirements, support and cost. It is important to note that the support costs can sometimes be higher than the actual license costs.
The database data repository has 1 schema/database that will hold the metadata. Inside the database you will find two reposit ories; tables
and Indexes. The tables are further split into three Enovia constructs called Vaults:
Admin Vault : Contains the admin objects related to the 3DEXPERIENCE platform
Production Vault : Contains the structured data related to 3DSpace
VPLM Vault : Contains the structured data related to 3DSpace Native applications

274
3DSpace: Key Parameters

Configure and launch Full Text Search: This process registers the config.xml file and requests the execution of a Full index. It also creates a
task in the task scheduler of the Operating system for partial indexation. Leave this check box cleared if other services and/or apps need to be
installed after 3DSpace (which is generally the case). If you do not select this check box, you will need to perform post-installation steps to
register the config.xml file, perform full indexation, etc.

Business & Administrator password: The Business user refers to the creator user, by default the creator user password is blan k at the end of the
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

installation process it is recommended to set the creator password to a strong value. The admin_platform user password has to match the one
set in 3DPassport, otherwise you will have issues.

Mail options: Of much lower importance but recommended for 3DEXPERIENCE platform administrator messages.

Application ports & Instance options: For the external TomEE+ instance be sure that you have the proper OS permissions as the application
may need to add, alter or update binaries, libraries or configuration files.

275
3DSpace: Key Parameters

Note: The 3DSpace service is the only one that has two WAR files which need to be deployed in two distinct application servers. The
3dspace.war file, which is the normal CAS security dependent file and the internal .war file which is the NoCAS file.

A Central Authentication Service application depends on 3DPassport and through 3DPassport an optional LDAP service. It is important
that normal user do not have access to the NoCAS application because it bypasses the secure CAS environment.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

276
3DSpace: Key Parameters

Available Installation Options :

Install the embedded JDK


Install the embedded TomEE+
Building the application (.war file)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Training Path: More flexibility, control and options (more experience).

277
3DSpace: GA Media Installer

GA core components have two different installation methodologies:

The global 3DEXPERIENCE platform Installer found in:


<Media>\AM_3DEXP_Platform.AllOS\1\
Navigate to this path and find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

o GUI: setup.exe
o TUI: StartTUI.exe
This installer is primarily used when you want to deploy multiple services on one machine

Classic "Service Installer" are available in :


<Media>\AM_3DEXP_Platform.AllOS\2\3DSpace\Windows64\1

Start the GUI installer corresponding to your preference.

278
Exercise: 3DSpace GA

1. In this exercise, you will:

a. Install the GA 3DSpace


b. Perform the GA post configuration
c. Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validate the GA service

60 minutes

279
3DSpace: GA Media Installer

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select "3DSpace" and click install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

280
3DSpace: GA Media Installer

3. Using the Cheat-sheet on the next page, proceed to the installation, don’t forget the installer options related to:
a. Install the embedded JDK  No
b. Build the application  No
c. Install the embedded TomEE+  No
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

281
3DSpace: Key Parameters

During the Installation you will be queried about the following parameters:

Make sure to enter mytraining.com instead of mydomain. This


DNS is specific for this training and would vary in the real world.

Cheat-Sheet :
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Step
Key Value
s

01 Installer <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe

02 Global platform Installer 3DSpace Service

03 Installation Directory D:\3DEXPERIENCE\R2023x\3DSpace

04 Install Embedded JDK No

05 JDK PATH D:\3DEXPERIENCE\Java64\jdk17

06 DB Selection Oracle or SQLServer are supported

DB Net Service name C:\app\dbadmin\network\admin

User Name X3DSPACEADMIN

User Password X3DSPACEADMIN


07
Net_service_name X3DEXP

Administration Tablespace X3DSPACEADMIN_DAT

Index Tablespace X3DSPACEADMIN_IND

282
3DSpace: Key Parameters

During the Installation you will be queried about the following parameters:
Cheat-Sheet :

Steps Key Value

SQL Server Connection User Name x3dspace


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

SQL Server Connection User Password Passport#1

SQL Server Database Name x3dspacedb

08 SQL Server Name localhost\X3DEXP

Create a new SQL Server database No

MSSQL files location: C:\DassaultSystemes\3DEXP_DB <Keep default>

Default and Administration data Filegroup: M1_DAT M1_DATA

Default and Administration index Filegroup: M1_IND M1_INDEX

Password for Business and System Administration Privileges <empty> Note: It refers to the creator user.

09 Administrator password Zaq1@WsxCde3 Note: It refers to admin_platform

File Storage D:\3DEXPERIENCE\data\3DSpaceData

10 Update database Yes

Tablespace Production X3DSPACEPRD_DAT

11 Tablespace Production index X3DSPACEPRD_IND


Oracle Tablespace vplm X3DSPACEVPLM_DAT

Tablespace vplm index X3DSPACEVPLM_IND


283
3DSpace: Key Parameters

During the Installation you will be queried about the following parameters:
Cheat-Sheet :
Steps Key Value

Tablespace Production I1_DATA


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Tablespace Production index I1_INDEX


SQL Server Tablespace vplm V1_DATA

Tablespace vplm index V1_INDEX

3DPassport URL https://3dpassport.mytraining.com:443/3dpassport

3DSpace Index Configuration


http://3dspaceindex.mytraining.com:19000
URL

3DSearchService URL https://3dsearch.mytraining.com:443/federated

3DDashboard URL https://3ddashboard.mytraining.com:443/3ddashboard


12
3DSpace Service URL https://3dspace.mytraining.com:443/3dspace

3DSWYM URL https://3dswym.mytraining.com:443/3dswym

3DComment URL https://3dcomment.mytraining.com:443/3dcomment

3DNotification https://3dnotification.mytraining.com:443/3dnotification

3DMessaging URL <empty>

Mail server name smtp.mytraining.com


13
Mail sender name [email protected]

284
3DSpace: Key Parameters

Steps Key Value

Build the Application No


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

14 Install Application No

Java heap Medium

15 Configure and launch Full Text Search No

Create Tools entries in Start Menu Yes


16
Create Shortcuts on the Desktop Yes

285
3DSpace: GA Media Installer – Oracle Summary
It s strongly recommended that you copy the summary information into a log prior to clicking "Install".
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

286
3DSpace: GA Media Installer – SQL Server Summary

1. It s strongly recommended that you copy the summary information into a log prior to clicking "Install".
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

287
3DSpace: GA Post Installation

3DSpace installer immediately creates the database objects, so DB setup is critical. You should not have selected to build the application (.war file)
because you still need to install the centrals and connectors. If you do not plan to deploy anything else then TomEE+ should be ready to start.

1. Before running this post installation action ensure that your 3DPassport is running and accessible. You may not get this message if 3DPassport is
running. 3DSpace installation will run this batch during installation. You can check Everything.log file in
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

D:\3DEXPERIENCE\R2023x\3DSpace\InstallData\log folder to check the execution.

The script executes an MQL command, it is recommended


to review the file to ensure all the values are properly set.

288
3DSpace: GA Post Installation

2. Since we did not select the option “Configure and launch Full Text search indexing just after 3DSpace installation”, we will need to perform
post-installation steps to register the config.xml file, perform full indexation and create an entry in Task Scheduler.

a. to import config.xml and perform a baseline/full indexation:


<3DSpaceInstallPath>/<OS>/code/command/FullTextSearch_PostInstall.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. To create an entry in Task Scheduler, use:


<3DSpaceInstallPath>/<OS>/code/command/registerCrontaskFullTextSearch.bat

289
3DSpace: GA Post Installation

3. Another important log that should be reviewed is the certificate import log, you may have a situation where some of the certificates are not
applicable and will not be imported. Each circumstance needs a particular operation.

This log is under the “tmp” folder of the normal Error.log location:
<Code Path>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_CSMA.media
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\tmp\Errors_import_certs.log

The file that this process is trying to update is :


D:\3DEXPERIENCE\Java64\jdk17\lib\security\cacerts

This error message is normal because the installer tries to add all files in the target folder and a few of the files are not certificates.

290
3DSpace: GA Post Installation

4. Go to your 3DEXPERIENCE folder and edit the file: D:\3DEXPERIENCE\conf\3dexperience.conf


In the section "3DSpace" replace the line:
#XXXX Future fragment file XXXX
With:
include D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\templates\3DSpace_httpd_fragment.conf
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

In the section "3dspace Internal" replace the line:


#XXXX Future fragment file XXXX
With:
include D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\templates\3DSpace_httpd_fragment.conf

291
3DSpace: GA Post Installation

5. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\templates\3DSpace_httpd_fragment.conf
Update the values for "port" and "FQDN" in the fragment file
http://3dspace.mytraining.com:8380/3dspace
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

http://internal.mytraining.com:8480/internal

6. Backup the fragment file to:


D:\3DEXPERIENCE\conf\Fragment\3DSpace_httpd_fragment.conf.GA

7. Copy the "UserIntentions_CODE.xml" file in D:\3DEXPERIENCE\R2023x\3DSpace\InstallData


To  D:\3DEXPERIENCE\conf\UserIntentions\
And rename it to: UserIntentions_3DSpace.xml

292
3DSpace: GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.
There are 5 steps related to the installer log, database and expected file deployment

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DSpace


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. Installer error log should be 0 bytes and can be found at:


<Code>\InstallData\log\ <Latest timestamp>-0000_CODE_win_b64_X3D_CSMA.media\Errors.log & *Stderr.txt
Size should be 0 bytes

If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

2. Expected file and/or folder creation:


<TomEE+ 3DSpace>\bin\setenv.bat

293
3DSpace: GA Technical Validation

3. Expected file and/or folder creation: (Internal)


a. <TomEE3DSpaceInternal>\bin\setenv.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Check that you have 3 new icons on your desktop (rename them for visibility):

a. BuildDeploy3DSpace_CAS  WAR 3DSpace


b. BuildDeploy3DSpace_NoCAS  WAR Internal
c. MQL  MQL Client

You need to be familiar with these tools as they will be used after Central installation, FP installation or code deployment.

294
Exercise: 3DSpace GA

1. In this exercise, you have:

 Installed the GA 3DSpace


 Performed the GA post configuration
 Performed Technical validation of GA service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Validated the GA service

295
3DSpace – GA Application

For 3DSpace, if you are adding additional applications, the process is as follows:
1. GA 3DSpace installation
2. GA Application installation
3. FP 3DSpace installation
4. FP Application installation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Notice that you Install all GA for the applications before installing the 3DSpace FP.

When GA is done, you will come back to this point of the document and continue with the next chapter 3DSpace FP Service Installer.

296
3DSpace – GA Application

1. At this point in time, you could technically deploy the 3DSpace Service with TomEE+. However, we want to enrich 3DSpace services with additional
applications. Currently you have the option of deploying the following modules:

2. Install Collaborative Industry Innovator Apps (CSV App Solution)


a. Some of these applications are mandatory a
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Other are optional

3. Before starting with the CSV Apps installation, disable the task for “FTS_Indexing”
a. Go to Start Windows Administrative Tools
b. Launch Task Scheduler
c. Task Scheduler Library  FTS_Indexing_Task  Disable

297
Exercise: Collaborative Industry Innovator Apps

1. Introduction
2. 3DSpace “Collaborative Industry Innovator” Apps
00. 3DExplore
01. ENOVIAIPClassificationFoundation
02. ENOVIACollaborativeTasksFoundation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

03. ENOVIAX-CADDesignFoundation *
04. ENOVIACollaborationforMicrosoftServer *
05. ConnectorforCATIAV5Server *
06. ENOVIAEnterpriseChangeManagement
07. ENOVIAProjectManagementFoundation
08. ENOVIAProgramChangeControlFoundation
09. ENOVIAEngineeringBOMManagementFoundation
10. ENOVIAUnifiedX-CADDesignManagement *
11. ENOVIADocumentManagement

Note: #1, #2 and #3 are mandatory.

* If you do not have client machine in this training, there is no need of installing the media

60 minutes

298
Introduction

You have just finished installing the 3DSpace GA components for the 3DEXPERIENCE platform, at this point the 3DEXPERIENCE platform will be
functional but additional products are required for the CSV App functionality.

The following is the list of CSV products that will be added to the base 3DSpace installation:
00. 3DExplore
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

01. ENOVIAIPClassificationFoundation
02. ENOVIACollaborativeTasksFoundation
03. ENOVIAX-CADDesignFoundation *
04. ENOVIACollaborationforMicrosoftServer *
05. ConnectorforCATIAV5Server *
06. ENOVIAEnterpriseChangeManagement
07. ENOVIAProjectManagementFoundation
08. ENOVIAProgramChangeControlFoundation
09. ENOVIAEngineeringBOMManagementFoundation
10. ENOVIAUnifiedX-CADDesignManagement *
11. ENOVIADocumentManagement

* If you do not have client machine in this training, there is no need of installing the media

299
3DEXPERIENCE platform: 3DSpace Enhancement

Before proceeding there are a few steps to take due to the fact that 3DSpace is currently online.

Stop the 2 TomEE+ related to 3DSpace:


D:\3DEXPERIENCE\TomEE\TomEE3DSpaceInternal
D:\3DEXPERIENCE\TomEE\TomEE3DSpace
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Under the 3DSpace TomEE+, delete the files from the following directories:
logs
work
temp

Delete the files under the following 3Dspace installation folders (if files are available):
D:\3DEXPERIENCE\R2023x\3DSpace\distrib_CAS
D:\3DEXPERIENCE\R2023x\3DSpace\distrib_NoCAS

You are now ready to proceed.

If you do not want to install the applications in this document, or do not have time, go back to the Server core document and continue applying the FP
for 3DSpace. When instructed to refer back to this doc for installation of the CSV App FP you may ignore that as well.

300
About Collaborative Industry Innovator Apps

It is the only offering on the market that provides 3D design capabilities for both styling and engineering in one integrated platform – the
3DEXPERIENCE platform.
Brands can implement effective design-for-cost product development and manufacturing strategies, using the most efficient product management
tools, while managing their product and project information throughout the development process. As a result, their products are launched to market
faster and in compliance with sustainability and safety norms.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

301
CSV Apps : Pre-Check

You should have previously completed the 3DSpace preparation, the following prerequisite is required:

Completed the 3DSpace Server GA Core deployment

You will not be able to proceed if this is missing.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

302
CSV Apps : Configuration and Key Parameters

In the training context we have already provided the installation sequence so there is no need for a backup prior to installing the apps.

Configuration impacts:
Database objects : Updated
TomEE+ needed : Updated
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Installing applications involves updating the 3DSpace component. The information requested for installation is usually minim al:
Path of 3DSpace installation
Business and system user id, that is, creator
The password is also required.

303
CSV Apps : Configuration and Key Parameters

These add-ons are usually quick to install. As with the Server core components we will use a universal
Cheat-Sheet for all installers

Cheat-Sheet:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Steps Key Value

DSY Installer Path


01 This is only asked if path is not found by <Media>\AM_3DEXP_Platform.AllOS\1\DS_Installer\1
default.

02 Server Installation Folder D:\3DEXPERIENCE\R2023x\3DSpace

03 Installation folder <Keep Default proposed under 3DSpace>

Name of Business & Admin user creator


04
Password of Business & Admin user <empty>

05 Update database Yes

Path of the custom schema file


06 <Keep Default proposed under 3DSpace>
Note: Not all installers will request this info.

304
CSV Apps : GA Installers

There is no global 3DEXPERIENCE platform Installer for the 3DSpace app add-ons but the installation process is quite simple. The most difficult
challenge is figuring out where the installers are on the DVD’s:

Installers will be compressed, available in the following generic PATH:


<Media>\AM_3DEXP_<DVD Media>.AllOS\<The Installer>
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

You will need to copy the file to “Your Installer PATH” folder and extract it.

You will find the normal executable <Installers>\<Extracted Code>\1:


oGUI: setup.exe
oTUI: StartTUI.exe

For each installer the media location will be provided:


<DVD Media>.Windows64  The DVD name
<The Installer>  The Path and File name

305
CSV Apps : GA Installers

All CSV applications will get installed under:


D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<Application>

You should keep an eye on this folder during the installations. In some cases an installer may create more than one folder under the Apps
folder. This is important to know if you want to properly technically validate the installer’s log files.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Finally when installing from “Your Installer PATH”, keep track of what you have installed. A good suggestion is to number the installer folders in
sequence.

In both Media and Installer folders:


“Your Installer PATH”
“Your Media PATH”
avoid spaces and long paths.

306
CSV Apps : GA Installers

Following table illustrates the CSV Apps installed:

CSV App Name Description


Bookmark allows you to create and manage a hierarchical
structure of folders to logically organize your folder, reference and
3DExplore
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

representation objects.
The Bookmark Editor app is part of CSV-Industry Innovation.
It helps in creating different types of libraries and their related
ENOVIAIPClassificationFoundation –
hierarchies. You can also create and manage documents and
Library
parts.
It consolidates the features (configurable user interface and
schema) that helps to interact with the user interface and objects
ENOVIACollaborativeTasksFoundation
for all apps. You can collaborate with other members while
maintaining access controls to the content.
ENOVIAX-CADDesignFoundation * It allows to integrate CAD tools with Enovia apps.
It allows to access and manage documents within the Microsoft
ENOVIACollaborationforMicrosoftServer* applications. You can perform product search, standardize
documents.
ConnectorforCATIAV5Server * It helps in data migration.

* If you do not have client machine in this training, there is no need of installing the media

307
CSV Apps : GA Installers
Following table illustrates the CSV Apps installed (continued):

CSV App Name Description


It provides a specific process for an organization to request changes to objects,
manage the changes, and track the changes to completion. Each person can be
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

assigned a role that determines what they are allowed to do in the process.
ENOVIAEnterpriseChangeManagement
Some users may review and approve changes while others may only view
submitted changes. Each step in the change process can be communicated, as
required, throughout the organization.
It is a powerful project management tool that allows to create programs and
ENOVIAProjectManagementFoundation
projects and store them in a database.
It helps to manage changes to products that are complicated and often
ENOVIAProgramChangeControlFoundation decomposed into a series of sub changes to make the work more manageable
and traceable.
It helps to consolidate the part design and technical content from various
ENOVIAEngineeringBOMManagementFoundation engineering applications. You can also manage part structure.

Unified X-CAD Design Management offer a flexible and powerful way to manage
ENOVIAUnifiedX-CADDesignManagement* and control information between 3DEXPERIENCE COLLABORATION
PLATFORM and various CAD systems
Document Management is a dashboard app that lets you manage your
ENOVIADocumentManagement
documents. A document is a container for files uploaded from a user's computer.

308
CSV Apps : GA - DS_Installer

The DS Installer is a set of installation tools used for installing server and client apps.
The DS Installer is delivered on a separate media which you need to use depending on the app you are installing.

Based on your OS:


a. Navigate to
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Media>\AM_3DEXP_platform.AllOS\3\DS_Installer\DS_Installer-V6R2023x.Windows64.zip

b. Go to the following folder:


<Installers>\DS_Installer.Windows64\1

c. There is no need to install anything for the DS_Installer, the Apps installation uses the installer to execute.

309
CSV Apps : GA - 3DExplore

Based on your OS:


a. Navigate to your <Media>\AM_3DEXP_Platform.AllOS\1\CSV-CollaborativeIndustryInnovator\3DExplore
b. Extract the file, you can delete the compressed version in “Your Installer Path” after it has been extracted.
d. Navigate to <Media>\AM_3DEXP_Platform.AllOS\2\CSV-CollaborativeIndustryInnovator\3DExplore\3DExplore.Windows64\1
e. Execute the installer based on your preference:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

I.GUI: setup.exe
II.TUI: StartTUI.exe

f. Choose the installation directory as : D:\3DEXPERIENCE\R2023x\3DSpace\3DExplore

Files will be installed in the following directory:


D:\3DEXPERIENCE\R2023x\3DSpace\3DExplore
The server installation directory:
D:\3DEXPERIENCE\R2023x\3DSpace
Super User name: creator
Database will be updated

310
CSV Apps : GA - 3DExplore

f. The application being installed is/are:


3DExplore

g. Once the installation is done, copy and rename "UserIntentions_CODE.xml". All App user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\3DExplore\InstallData\UserIntentions_CODE.xml
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
D:\3DEXPERIENCE\R2023x\3DSpace\3DExplore\InstallData\log
<Time Stamp>-0000_CODE_win_b64_ENOVIA_RIPE.media

i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\3DExplore\

311
CSV Apps : GA - ENOVIAIPClassificationFoundation

Based on your OS:


a. Navigate to your
<Media>\AM_3DEXP_Platform.AllOS\1\CSV-CollaborativeIndustryInnovator\ENOVIAClassifyandReuse

b. Extract the file, you can delete the compressed version in “Your Installer Path” after it has been extracted.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Go to the following folder: "ENOVIAClassifyandReuse"


ENOVIAIPClassificationFoundation-V6R2023x.Windows64.zip

d. Extract the file in “Your Installer PATH” ENOVIAIPClassificationFoundation.Windows64\1

e. Execute the installer based on your preference:


I.GUI: setup.exe
II.TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\LibraryCentral\V6R2023x
Super User name: creator
Database will be updated
Custom Schema Path:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\LibraryCentral\V6R2023x\Apps\
SchemaInstaller\CustomSchema

312
CSV Apps : GA - ENOVIAIPClassificationFoundation

f. The application being installed is/are:


LibraryCentral

g. Once the installation is done, copy and rename "UserIntentions_CODE.xml". All App user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<InstalledApp>\V6R2023x\InstallData\
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\LibraryCentral\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_LBC.media
i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\LibraryCentral\

313
CSV Apps : GA - ENOVIACollaborativeTasksFoundation

Based on your OS:


a. Navigate to your
<Media>\AM_3DEXP_Platform.AllOS\1\CSV-CollaborativeIndustryInnovator\ENOVIACollaborativeTasks

b. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Go to the following folder: "ENOVIACollaborativeTasks"


ENOVIACollaborativeTasksFoundation-V6R2023x.Windows64.zip

d. Extract the file in "Your Installer PATH" ENOVIACollaborativeTasksFoundation.Windows64\1

e. Execute the proper installer based on your "<OS>"


I.GUI: setup.exe
II.TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\CollaborativeTasks\V6R2023x
Super User name: creator
Database will be updated
Custom Schema Path:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\CollaborativeTasks\V6R2023x
\Apps\SchemaInstaller\CustomSchema

314
CSV Apps : GA - ENOVIACollaborativeTasksFoundation

f. The application being installed is/are:


CollaborativeTasks

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All "App" user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<InstalledApp>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\CollaborativeTasks\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_TASK.media
i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\CollaborativeTasks\

315
CSV Apps : GA - ENOVIAX-CADDesignFoundation

Based on your OS:


a. Navigate to your
<Media>\AM_3DEXP_Platform.AllOS\1\ENOVIAX-CADDesignManagement

b. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Go to the following folder: "ENOVIAX-CADDesignManagement"


ENOVIAX-CADDesignFoundation-V6R2023x.Windows64.zip

d. Extract the file in "Your Installer PATH" ENOVIAX-CADDesignFoundation.Windows64\1

e. Execute the proper installer based on your "<OS>"


I. GUI: setup.exe
II. TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\DesignerCentral\V6R2023x
Super User name: creator

316
CSV Apps : GA - ENOVIAX-CADDesignFoundation

f. The application being installed is/are:


DesignerCentral

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All "App" user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<InstalledApp>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\DesignerCentral\V6R2023x\InstallData\log\
II. <timestamp>-0000_CODE_win_b64_ENOVIA_DCF.media
i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\DesignerCentral\

317
CSV Apps : GA - ENOVIACollaborationforMicrosoftServer

Based on your OS:


a. Navigate to your
<Media>\AM_3DEXP_Platform.AllOS\1\CSV-CollaborativeIndustryInnovator\CollaborationforMicrosoft

b. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Go to the following folder: "CollaborationforMicrosoftServer"


ENOVIACollaborationforMicrosoftServer-V6R2023x.Windows64.zip

d. Extract the file in "Your Installer PATH" ENOVIACollaborationforMicrosoftServer.Windows64\1

e. Execute the proper installer based on your <OS>


I. GUI: setup.exe
II. TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\Integrations\MSF\V6R2023x
Super User name: creator

318
CSV Apps : GA - ENOVIACollaborationforMicrosoftServer

f. The application being installed is/are:


Integrations\MSF

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All "App" user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<InstalledApp>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\Integrations\MSF\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_MFS.media
i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\Integrations\MSF\

319
CSV Apps : GA - ConnectorforCATIAV5

Based on your OS:


a. Navigate to your
<Media>\AM_3DEXP_Platform.AllOS\1\ENOVIAX-CADDesignManagement

a. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Go to the following folder: "ENOVIAX-CADDesignManagement"


ConnectorforCATIAV5Server-V6R2023x.Windows64.zip

d. Extract the file in "Your Installer PATH" ConnectorforCATIAV5Server.Windows64\1

e. Execute the proper installer based on your <OS>


I. GUI: setup.exe
II. TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\ConnectorforCATIAV5\V6R2023x
Super User name: creator

320
CSV Apps : GA - ConnectorforCATIAV5

f. The application being installed is/are:


ConnectorforCATIAV5

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All "App" user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<Installed App>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\ConnectorforCATIAV5\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_CT5.media
i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\ConnectorforCATIAV5\

321
CSV Apps : GA - ENOVIAEnterpriseChangeManagement

Based on your OS:


a. Navigate to your <Media>\AM_3DEXP_Platform.AllOS\1\CSV-CollaborativeIndustryInnovator\ENOVIAEnterpriseChangeManagement
b. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted.

c. Go to the following folder: "ENOVIAMyChanges"


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ENOVIAEnterpriseChangeManagement-V6R2023x.Windows64.zip

d. Extract the file in "Your Installer PATH" ENOVIAEnterpriseChangeManagement.Windows64\1

e. Execute the proper installer based on your "<OS>"


GUI: setup.exe
TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EnterpriseChangeMgt\V6R2023x
Super User name: creator
Database will be updated
Custom Schema Path:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EnterpriseChangeMgt\V6R2023x\Apps\
SchemaInstaller\CustomSchema

322
CSV Apps : GA - ENOVIAEnterpriseChangeManagement

f. The application being installed is/are:


EnterpriseChangeMgt

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All "App" user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<Installed App>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EnterpriseChangeMgt\V6R2023x\InstallData\log\<TimeStamp>
-0000_CODE_win_b64_ENOVIA_ECM.media4
II. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EnterpriseChangeMgt\

323
CSV Apps : GA - ENOVIAProjectManagementFoundation

Based on your OS:


a. Navigate to your <Media>\AM_3DEXP_Platform.AllOS\1\CSV-CollaborativeIndustryInnovator\ENOVIAProjectManagement

b. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Go to the following folder: "ENOVIAProjectManagement"


ENOVIAProjectManagementFoundation-V6R2023x.Windows64.zip

d. Extract the file in <Installers>\ENOVIAProjectManagementFoundation.Windows64\1

e. Execute the proper installer based on your "<OS>"


GUI: setup.exe
TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\ProgramCentral\V6R2023x
Super User name: creator
Database will be updated
Custom Schema Path:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\ProgramCentral\V6R2023x\
Apps\SchemaInstaller\CustomSchema

324
CSV Apps : GA - ENOVIAProjectManagementFoundation

f. The application being installed is/are:


ProgramCentral

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All App user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<InstalledApp>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\ProgramCentral\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_PRF.media
i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\ProgramCentral\

325
CSV Apps : GA - ENOVIAProgramChangeControlFoundation

Based on your OS:


a. Navigate to your <Media>\AM_3DEXP_Analytics.AllOS\1\Software\ENOVIAProgramChangeControlFoundation

a. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Go to the following folder: ENOVIAProgramandContractManagement


ENOVIAProgramChangeControlFoundation-V6R2023x.Windows64.zip

d. Extract the file in "Your Installer PATH" ENOVIAProgramChangeControlFoundation.Windows64\1

e. Execute the proper installer based on your "<OS>"


GUI: setup.exe
TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EnterpriseChange\V6R2023x
Super User name: creator
Database will be updated
Custom Schema Path:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EnterpriseChange\V6R2023x\
Apps\SchemaInstaller\CustomSchema

326
CSV Apps : GA - ENOVIAProgramChangeControlFoundation

f. The application being installed is/are:


EnterpriseChange

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All App user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<Installed App>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EnterpriseChange\V6R2023x\InstallData\log\
II. <TimeStamp>_CODE_win_b64_ENOVIA_ECH.media
i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EnterpriseChange\

327
CSV Apps : GA - ENOVIAEngineeringBOMManagementFoundation

Based on your OS:


a. Navigate to your <Media>\AM_3DEXP_WebApps.AllOS\1\Software\ENOVIAEngineeringBOMManagementFoundation
b. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted.
c. Go to the following folder: "ENOVIAEngineeringBOMManagement"
ENOVIAEngineeringBOMManagementFoundation-V6R2023x.Windows64.zip
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Extract the file in <Your Installer PATH>


ENOVIAEngineeringBOMManagementFoundation.Windows64\1

e. Execute the proper installer based on your "<OS>"


I. GUI: setup.exe
II. TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EngineeringCentral\V6R2023x
Super User name: creator
Database will be updated
Custom Schema Path:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EngineeringCentral\V6R2023x\
Apps\SchemaInstaller\CustomSchema

328
CSV Apps : GA - ENOVIAEngineeringBOMManagementFoundation

f. The application being installed is/are:


EngineeringCentral

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All App user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<Installed App>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EngineeringCentral\V6R2023x\InstallData\log\
II. <Timestamp>2-0000_CODE_win_b64_ENOVIA_ENG.media

i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EngineeringCentral

329
CSV Apps : GA - ENOVIAUnifiedX-CADDesignManagement

Based on your OS:


a. Navigate to your <Media>\AM_3DEXP_Platform.AllOS\4\ENOVIAUnifiedX-CADDesignManagement

b. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted. ENOVIAUnifiedX-
CADDesignManagement-V6R2023x.Windows64.zip
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Extract the file in <Your Installer PATH>


ENOVIAUnifiedX-CADDesignManagement.Windows64\1

d. Execute the proper installer based on your "<OS>"


I. GUI: setup.exe
II. TUI: StartTUI.exe

The server installation directory:


D:\3DEXPERIENCE\R2023x\3DSpace
Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\UnifiedX-
CADDesign\V6R2023x
Administrator name: admin_platform
Administrator password: Zaq1@WsxCde3
Super User name: creator
Database will be updated

330
CSV Apps : GA - ENOVIAUnifiedX-CADDesignManagement

f. The application being installed is/are:


UnifiedX-CADDesign

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All App user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<Installed App>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\UnifiedX-CADDesign\V6R2023x\InstallData\log\<timestamp>-
0000_CODE_win_b64_ENOVIA_UCAD.media

i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\UnifiedX-CADDesign\

331
CSV Apps : GA - ENOVIADocumentManagement

Based on your OS:


a. Navigate to your <Media>\AM_3DEXP_Platform.AllOS\1\
CSV-CollaborativeIndustryInnovator\ENOVIADocumentManagement
a. Extract the file, you can delete the compressed version in "Your Installer PATH" after it has been extracted. ENOVIADocumentManagement-
V6R2023x.Windows64.zip
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Extract the file in <Your Installer PATH>


ENOVIADocumentManagement.Windows64\1

c. Execute the proper installer based on your "<OS>"


I. GUI: setup.exe
II. TUI: StartTUI.exe

The server installation directory: D:\3DEXPERIENCE\R2023x\3DSpace


Files will be installed in the following directory:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\DocumentManagement\V6R2023x
Super User name: creator
Database will be updated

332
CSV Apps : GA - ENOVIADocumentManagement

f. The application being installed is/are:


ENOVIA Document Management

g. Once the installation is done, copy and rename the "UserIntentions_CODE.xml". All App user intention files will be located under:
D:\3DEXPERIENCE\R2023x\3DSpace\Apps\<Installed App>\V6R2023x\InstallData
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

\UserIntentions_CODE.xml
Copy it to:
D:\3DEXPERIENCE\conf\UserIntentions\UserIntentions_<Installed App>.xml
Note: If the name of the installed App folder is not obvious, check the time stamp of the folder

h. Make sure there are no installation errors. The Errors.log & *Stderr.txt files are found in:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\DocumentManagement\V6R2023x\InstallData\log\
II. <timestamp>-0000_CODE_win_b64_ENOVIA_DOCM.media

i. Application installation location: D:\3DEXPERIENCE\R2023x\3DSpace\Apps\DocumentManagement\

333
CSV Apps – GA Application

With the other 3DEXPERIENCE platform Services you apply a Fix Pack immediately after the GA installation. 3DSpace is a special case if you are
adding additional applications, the process is as follow:

1) GA 3DSpace installation
2) GA Application installation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3) FP 3DSpace installation
4) FP Application installation

Notice that you Install all GA for the applications before installing the 3DSpace FP.

Next steps:
o 3DSpace FP installation
o Then "CSV Apps FP Application"

334
3DSpace – Post Install

You have completed:

 GA 3DSpace installation
 GA Application installation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

335
3DSpace – Post Actions

1. Edit the setenv.bat in the TomEE+ 3DSpace(CAS)


D:\3DEXPERIENCE\TomEE\TomEE3DSpace\bin\setenv.bat

2. update the last line with:


CALL D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\templates\setenvCAS.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

NOTE : The file “setenvCAS.bat” has two variables ”MX_PAM_AUTHENTICATE_CLASS”


and ”MX_PAM_AUTHENTICATE_ARG”. These variables are used to configure
external authentication.
3. Save the file.

4. Open MQL using the desktop shortcut and execute the following commands:
set context user creator;
compile prog * force; To save time, you can execute
quit; compile prog * force size
250;

There should be no compile errors. This command may take a while depending on the characteristics of the machine (~15 to 20minutes).

336
3DSpace - WAR Build

The "WAR" build process is the act of merging the 3DSpace GA+FP code and any creating a J2EE applications.

a. The applications are normally installed under the folder:


D:\3DEXPERIENCE\R2023x\3DSpace\Apps
b. They also have code integrated to the stack under the folder:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

D:\3DEXPERIENCE\R2023x\3DSpace\STAGING
c. The "WAR" will be created under:
D:\3DEXPERIENCE\R2023x\3DSpace\distrib

The WAR builder batch file are BuildDeploy3DSpace_NoCAS.bat and BuildDeploy3DSpace_CAS.bat under
D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\code\command

The STAGING folder is where the 3DSpace service will build the WAR file from. It will then copy the war file to the distrib folder which can then be
deployed to the 3DSpace TomEE+ instance. This process is why you need to rebuild the "WAR" file after installing any new application into 3DSpace.

337
3DSpace - WAR Build

Time to rebuild the web application to be deployed in:


a. 3DSpace TomEE+ code PATH : D:\3DEXPERIENCE\TomEE\TomEE3DSpace\webapps
b. 3DSpace Internal TomEE+ code PATH : D:\3DEXPERIENCE\TomEE\TomEE3DSpaceInternal\webapps

c. Make sure that both TomEE+ are stopped


d. Use the two shortcuts on your desktop, launch them one after the other: (Run as administrator)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DSpace does not automatically copy the WAR file to the application server, find the two folders containing the WAR files for TomEE3DSpace and
TomEE3DSpaceInternal

Copy only the .war file from the distrib folder to the webapps folder to each TomEE+:
a. TomEE3DSpace : D:\3DEXPERIENCE\R2023x\3DSpace\distrib_CAS
b. TomEE3DSpaceInternal : D:\3DEXPERIENCE\R2023x\3DSpace\distrib_NoCAS

In the distrib folder the other files and folders are not needed and should not be copied, to save space you can delete them.

338
3DSpace – Post Installation Validation

1. Open the enovia.ini file at D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\code\bin. Increase the MX_JAVA_OPTIONS and


MX_MEMORY_SYSTEM_LIMIT values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

MX_JAVA_OPTIONS=-Xmx4096m
MX_MEMORY_SYSTEM_LIMIT=8192m
2. Start and stop both TomEE+
<TomEE 3DSpace>\bin\startup.bat
<TomEE 3DSpace Internal>\bin\startup.bat
Wait for it to finish deploying the application.

<TomEE 3DSpace>\bin\shutdown.bat
<TomEE 3DSpace Internal>\bin\shutdown.bat
Wait for it to finish properly closing the application.

3. Check for errors and clean the log folder afterward


<TomEE 3DSpace>\logs\*.log
<TomEE3DSpace Internal>\logs\*.log

339
3DSpace: Validation

1. In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. Redirect to 3DSpace after Passport authentication

2. Restart the "Apache2.4" Service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

3. Start TomEE+ if not started


a. <TomEE 3DPassport>\bin\startup.bat
b. <TomEE 3DSpace>\bin\startup.bat
c. <TomEE 3DSpace Internal>\bin\startup.bat
Wait for each to finish deploying the application. Each time you test a new URL
bookmark it in Firefox.

MyURLs.html
4. Access the MyURLs.html or :
https://3dspace.mytraining.com:443/3dspace
https://internal.mytraining.com:443/internal

340
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. 3DSpace

2. 3DSpaceInternal
3DSpace: Validation

341
Exercise Recap: 3DSpace

1.You have completed the installation of the CSV Apps components for 3DSpace.

 3DEXPERIENCE server CSV Apps


 Performed post configurations
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2.The next step is core 3D Index server, this component is optional and only used by 3DEXPERIENCE Native clients. If you do not plan to use these
clients you can skip to the Client core components.

342
3DSpace: Uninstallation

Windows normal uninstall procedure:

a. Stop TomEE+ if it is running <Service Name>

b. In "Programs and Features" uninstall:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

Or the Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

c. In the Database instance, drop the user, tablespace / database.

d. Remove the folders:


D:\3DEXPERIENCE\R2023x\<Service Name>
D:\3DEXPERIENCE\TomEE\TomEE<Service Name>

343
3DNotification

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE Platform
About 3DNotification

3DNotification provides 3DEXPERIENCE platform users timely updates about activities going on in the system.

3DNotification is the service used to send push notification messages to 3DEXPERIENCE platform users.

A source app or service sends a notification request to the 3DNotification service.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The 3DNotification service processes the request.


The 3DNotification service sends a notification message to the 3DEXPERIENCE platform users via different channels (the notification center, alerts
and emails).

345
3DNotification: Architecture
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

* Always Refer the "Program Directory" for version and latest news.

346
3DNotification: Pre-Check

You should have previously prepared the groundwork to proceed with this service installation, you will require the following prerequisites:

Database objects (up and running)


1 SSL certificate
Java
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Note: You will not be able to proceed if any of these are missing.

Main Configuration requirement:


Database objects : Yes
Java dependent : Yes

347
3DNotification: Key Parameters

Installation Cook-book : Installation key parameter explained.

Keywords: application for 3DNotification.

Installation Directory: This is the location where the service code will be installed. Do not use blanks in the installation path if you can avoid it. It is
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

also recommended not to install on the C: drive. The C: drive is the system drive, if it gets corrupted or becomes full it could bring the service
down. By selecting another drive you will have better control and stability for the platform.

Install the embedded JDK: The JDK is required for certificate importation using the java keytool utility, the application wi ll not use the JDK at
execution time. You may choose to use the embedded release provided by the 3DEXPERIENCE platform or an external one. This second option will
be used during the training.

Database selection: This component supports both Oracle and SQL Server. The database recommendation is often based on two cri tical customer
requirements, support and cost. It is important to note that the support costs can sometimes be higher than the actual license costs.
The database has 1 schema/database.

3DNotification Repository: 3DNotification requires a special foot print on the disk for its logs, temporary transactions and data. This should be
treated similarly to an FCS, the data is not re-buildable like the 3DSpace Index server.

Mail options: Low importance but recommended for 3DEXPERIENCE platform administrator messages.

348
3DNotification: GA Media Installer

GA core components have two different installation methodologies:

The "global 3DEXPERIENCE platform Installer" found in:


<Media>\AM_3DEXP_platform.AllOS\1\
Navigate to this path and find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

GUI: setup.exe
TUI: StartTUI.exe
This installer is primarily used when you want to deploy multiple services on one machine

Classic "Service Installer" is available in:


<Media>\AM_3DEXP_Platform.AllOS\2\3DNotification\Windows64\1

Start the GUI installer corresponding to your preference.

349
3DNotification: GA Media installer

In this exercise, you will:

a. Install the GA 3DNotification


b. Perform the GA post configuration
c. Technical validation of the GA service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validate the GA service

15 minutes

350
3DNotification : GA Media Installer

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select the "3DNotification Service" and click Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

351
3DNotification: GA Media installer

3. Using the Cheat-sheet on the next page, proceed to the installation, don’t forget the installer options related to embedded JDK  No

NOTE - 3DNotification has its "own" Application server, therefore it does not need a TomEE+ application server, it will still be accessed via Apache
https security.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

352
3DNotification: Key Parameters

During the Installation you will be queried about the following parameters:

Make sure to enter mytraining.com instead of mydomain. This


DNS is specific for this training and would vary in the real world.
Cheat-Sheet :
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Steps Key Value

01 Global platform Installer <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe

02 Global platform Installer 3DNotification Service

03 Installation Directory D:\3DEXPERIENCE\R2023x\3DNotification

04 Install the embedded JDK No

05 JDK PATH D:\3DEXPERIENCE\Java64\jdk17

Directory for Shared Storage D:\3DEXPERIENCE\data\3DNotificationData

06 Directory for log D:\3DEXPERIENCE\data\3DNotificationLogs

Directory runtime temporary D:\3DEXPERIENCE\data\3DNotificationTmp

3DPassport URL https://3dpassport.mytraining.com:443/3dpassport

3DDashboard URL https://3ddashboard.mytraining.com:443/3ddashboard

07 3DCompass URL https://3dspace.mytraining.com:443/3dspace

3DSwym URL https://3dswym.mytraining.com:443/3dswym

3DNotification URL https://3dnotification.mytraining.com:443/3dnotification

08 NodeJS server Port 8680


353
3DNotification: Key Parameters

During the Installation you will be queried about the following parameters:

Cheat-Sheet :
Steps Key Value

Mail Server name smtp.mytraining.com


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

09 Mail sender name [email protected]

Ignore certificate for SMTP Yes

Directory containing "ora" files C:\app\dbadmin\network\admin

10 Net Service name X3DEXP


Oracle Database username X3DNOTIF

Database user's password X3DNOTIF

Database Host database.mytraining.com\X3DEXP:1433

Database name x3dnotification


10 Database Administrator username x3dsn_admin
SQL
Server Database Administrator user's password Passport#1

Database username x3dsn

Database user's password Passport#1

For SQL Server, we are using standard port 1433. If you are using non-standard port, then
additional post –configuration must be done.
The port must be specified using ",", not ":" in the configuration file.

354
3DNotification: GA Media Installer – Oracle Summary

It is strongly recommended that you copy the installation information into a text file prior to clicking the "install" button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable, can easily by


copied into report.

355
3DNotification: GA Media Installer – SQL Server Summary

It is strongly recommended that you copy the installation information into a text file prior to clicking the "install" button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable, can easily by


copied into report.

356
3DNotification: GA Post Installation

3DNotification installer is pretty simple, it installs a windows service.


a. The default service name is "3DEXPERIENCE R2023x 3DNotification Node"
b. To start and stop the node on Windows: start and stop the service "3DEXPERIENCE R2023x 3DNotification Node".
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DNotification service is deployed automatically after installation.

357
3DNotification: GA Post Installation

a. Go to your 3DEXPERIENCE folder and edit the file: D:\3DEXPERIENCE\conf\3dexperience.conf


In the section "3DNotification" replace the line: #XXXX Future fragment file XXXX
With:
Include D:\3DEXPERIENCE\R2023x\3DNotification\win_b64\templates\3DNotification_httpd_fragment.conf
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\3DNotification\win_b64\templates\3DNotification_httpd_fragment.conf
Update the values for "port" and "FQDN" in the fragment file.
http://3dnotification.mytraining.com:8680/socket.io
http://3dnotification.mytraining.com:8680

c. Backup the fragment file to:


D:\3DEXPERIENCE\conf\Fragment\3DNotification_httpd_fragment.conf.GA

d. Copy the "UserIntentions_CODE.xml" file in folder D:\3DEXPERIENCE\R2023x\3DNotification\InstallData


To folder: D:\3DEXPERIENCE\conf\UserIntentions\
and rename it to: UserIntentions_3DNotification.xml

358
3DNotification: GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DNotification

1. Installer error log should be 0 bytes and can be found at:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_INTF_SC.media
\Errors.log & *Stderr.txt
Size should be 0 bytes

If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

359
3DNotification: Validation

In this section you will validate the service functionality and part of the infrastructure deployment

1. Restart the Apache service


a. Open service manager
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Start 3DNotification Node


Start the 3DNotification service
Access the URL:
Each time you test a new
https://3dnotification.mytraining.com:443/3dnotification/ URL bookmark it in Firefox.

3DNotification will be redirected by Apache to a "3DNotification Service" page.


MyURLs.html

360
Exercise Recap: 3DNotification

1. In this exercise, you have:

 Installed the GA 3DNotification


 Performed the GA post configuration
 Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Validated the GA service

361
3DNotification: Uninstallation

Windows normal uninstall procedure:

Stop "3DEXPERIENCE R2023x 3DNotification Node" service

In the Database instance you must drop the user/database.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

In "Programs and Features" uninstall:


"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

Or the Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

Remove the folder:


D:\3DEXPERIENCE\R2023x\ <Service Name>

362
3DComment

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE platform
About 3DComment

3DComment provides the ability to interact with other 3DEXPERIENCE platform members by liking content, adding comments to any item.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

364
3DComment: Architecture
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

* Always Refer the "Program Directory" for version and latest news.

365
3DComment: Pre-Check

You should have previously prepared the groundwork to proceed with this service installation, you will require the following prerequisites:

Database objects (up and running)

TomEE+ (stopped)
1 TomEE+ is dedicated for the service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1 SSL certificate

Java

You will not be able to proceed if any of these are missing.

Main Configuration requirement:


Database objects : Yes
TomEE+ needed : Yes
Java dependent : Yes

366
3DComment: Key Parameters

Installation "Cook-book" : Installation key parameter explained.

Keywords: Notification broker for 3DSwym.

Installation Directory: This is the location where the service code will be installed. Do not use blanks in the installation path if you can avoid it. It is
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

also recommended not to install on the "C:\" drive. The "C:\" drive is the system drive, if it gets corrupted or becomes full it could bring the
service down. By selecting another drive you will have better control and stability for the platform.

"Installing Embedded JDK" & "Installing Embedded Apache TomEE+": 3DS service installer comes with java "JDK" and TomEE+. This can be
practical for small businesses and if you do not want to manage "other" software installations. The disadvantages are that it is harder to upgrade
and maintain Java security release and it cannot be easily implemented with load balancing.

"Database selection": This component supports both Oracle and SQL Server. The database recommendation is often based on 2 cri tical customer
requirements, support and cost. It is important to note that the support costs can sometimes be higher than the actual license costs.
The database data repository has 1 schema/database.

"3DComment Repository": 3DComment requires a special foot print on the disk for its logs, temporary transactions and data. Th is should be treated
similarly to an FCS, the data is not "re-buildable" like the 3DSpace Index server.

367
3DComment: GA Media Installer

GA core components have two different installation methodologies:

The "global 3DEXPERIENCE platform Installer" found in:


<Media>\AM_3DEXP_Platform.AllOS\1\
Navigate to this path and find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

GUI: setup.exe
TUI: StartTUI.exe
This installer is primarily used when you want to deploy multiple services on one machine

Classic "Service Installer" is available in:


<Media>\AM_3DEXP_Platform.AllOS\2

Start the GUI installer corresponding to your preference.

368
3DComment : GA Media installer

In this exercise, you will:

a. Install the GA 3DComment


b. Perform the GA post configuration
c. Technical validation of the GA service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validate the GA service

15 minutes

369
3DComment : GA Media Installer

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select the "3DComment Service" and click Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

370
3DComment: GA Media Installer

1. Using the Cheat-sheet on the next page, proceed to the installation, don’t forget the installer options related to:
a. Installing the embedded JDK  No
b. Installing the embedded TomEE+  No
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

371
3DComment: Key Parameters

During the Installation you will be queried about the following parameters:

Make sure to enter mytraining.com instead of mydomain . This


DNS is specific for this training and would vary in the real world.
Cheat-Sheet :
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Steps Key Value

01 Global platform Installer <Media>\AM_3DEXP_platform.AllOS\1\setup.exe

02 Global platform Installer 3DComment Service

03 Installation Directory D:\3DEXPERIENCE\R2023x\3DComment

04 Install the embedded JDK No

05 JDK PATH D:\3DEXPERIENCE\Java64\jdk17

Directory for Shared Storage D:\3DEXPERIENCE\data\3DCommentData

06 Directory for log D:\3DEXPERIENCE\data\3DCommentLogs

Directory run time temporary D:\3DEXPERIENCE\data\3DCommentTmp

3DPassport URL https://3dpassport.mytraining.com:443/3dpassport

3DDashboard URL https://3ddashboard.mytraining.com:443/3ddashboard

07 3D Compass URL https://3dspace.mytraining.com:443/3dspace

3DComment URL https://3dcomment.mytraining.com:443/3dcomment

3DNotification URL https://3dnotification.mytraining.com:443/3dnotification

372
3DComment: Key Parameters

During the Installation you will be queried about the following parameters:

Cheat-Sheet :
Steps Key Value
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

08 Install the embedded Apache TomEE+ No

09 Apache TomEE+ Installation path D:\3DEXPERIENCE\TomEE\TomEE3DComment\

10 DB Selection Oracle or SQL Server

Directory containing ora files C:\app\dbadmin\network\admin

11 Net Service name X3DEXP


Oracle
Database username X3DCOMMENT

Database user's password X3DCOMMENT

Database Host database.mytraining.com\X3DEXP:1433

Database name x3dcomment

11 Database Administrator username x3dsc_admin


SQL
Server Database Administrator user's password Passport#1

Database username X3dsc

Database user's password Passport#1

12 Use as batch server Yes

373
3DComment: GA Media Installer – Oracle Summary

It is strongly recommended that you copy the installation information into a text file prior to clicking Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

374
3DComment: GA Media Installer – SQL Server Summary

1. It is strongly recommended that you copy the installation information into a text file prior to clicking Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

375
3DComment: GA Post Installation

3DComment installer does not require much post installation work, just some preparation.

a. TomEE+ code PATH: D:\3DEXPERIENCE\TomEE\TomEE3DComment

b. Start and stop TomEE+ (or use you Desktop icon)


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<TomEE 3DComment>\bin\startup.bat
Wait for it to finish deploying the application.

<TomEE 3DComment>\bin\shutdown.bat
Wait for it to finish closing the application properly before shutting down the terminal …

c. Check the logs for any error and Clean log folder
<TomEE 3DComment>\logs\*.log

376
3DComment: GA Post Installation

d. Go to your 3DEXPERIENCE folder and edit the file: D:\3DEXPERIENCE\conf\3dexperience.conf


In the section "3DComment" replace the line: #XXXX Future fragment file XXXX
with: include D:\3DEXPERIENCE\R2023x\3DComment\win_b64\templates\3DComment_httpd_fragment.conf
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

e. Edit the fragment file : D:\3DEXPERIENCE\R2023x\3DComment\win_b64\templates\3DComment_httpd_fragment.conf


Update the values for "port" and "FQDN" in the fragment file : http://3dcomment.mytraining.com:8580

I.
f. Backup the fragment file to: D:\3DEXPERIENCE\conf\Fragment\3DComment_httpd_fragment.conf.GA

g. Copy the "UserIntentions_CODE.xml" file in folder


D:\3DEXPERIENCE\R2023x\3DComment\InstallData
To folder: D:\3DEXPERIENCE\conf\UserIntentions\
and rename it to: UserIntentions_3DComment.xml

377
3DComment: GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DComment


1. Installer error log should be 0 bytes and can be found at:
<Code>\InstallData\log\CODE\<Latest timestamp>-0000_CODE_win_b64_X3D_CMNT.media\Errors.log & *Stderr.txt
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Size should be 0 bytes


If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

2. Expected file and/or folder creation:


a. <TomEE 3DComment>\webapps\3dcomment.war
b. <TomEE 3DComment>\bin\setenv.bat

378
3DComment: Validation

1. In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. 3DComment TomEE

2. Restart the "Apache2.4" Service Each time you test a


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager new URL bookmark it


in Firefox.
3. Start TomEE
a. <TomEE 3DComment>\bin\startup.bat
Wait for it to finish deploying the application.
Access the MyURLs.html or
https://3dcomment.mytraining.com:443/3dcomment/monitoring/healthcheck
MyURLs.html

3DComment will respond with the following page.

379
Exercise Recap: 3DComment

1. In this exercise, you have:

 Installed the GA 3DComment


 Performed the GA post configuration
 Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Validated the GA service

380
3DComment: Uninstallation

Windows normal uninstall procedure:

Stop TomEE+ if it is running <Service Name>

In the Database instance, drop the 1 user/database.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

In "Programs and Features" uninstall:


"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

Or the Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

d. Remove the folders:


D:\3DEXPERIENCE\R2023x\<Service Name>
D:\3DEXPERIENCE\TomEE\TomEE<Service Name>

381
3DSwym

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE platform
About 3DSwym

The 3DSwym service provides social networking and community facilities, enabling cross -discipline collaboration of users anywhere in the
enterprise, and comprises three components:
3DSwym Foundation
3DSwym Video Converter
3DSwym Index
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

It is recommend that you install each of the above components on a different machine.

383
3DSwym : Architecture
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

* Always Refer the "Program Directory" for version and latest news.

384
3DSwym: Pre-Check

You should have already prepared the required details to proceed with this service installation, you will need the following pre-requisites:

Database objects (up and running)

TomEE+ (stopped)
1 TomEE+ is dedicated for the service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1 SSL certificate

Java

You will not be able to proceed if any of these are missing.

Main Configuration requirements:


Database objects : Yes
TomEE+ needed : Yes
Java dependent : Yes

385
3DSwym: Key Parameters

Installation Cook-book: Installation key parameters explained.

Installation Directory: This is the location where the service code will be installed. Do not use blanks in the installation, try if you can avoid it. It is
also recommended not to install on the "C:\" drive. The "C:\" drive is the system drive, if it gets corrupted or becomes full it could bring the
service down. By selecting another drive you will have better control and stability for the platform.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Installing Embedded JDK & Installing Embedded Apache TomEE+: 3DS service installer comes with java JDK and TomEE+. This can be practical
for small businesses and if you don not want to manage other software installations. The disadvantages are that it is harder to upgrade and
maintain Java security release and it cannot be easily implemented with load balancing.

Database selection: This component is supported on both Oracle and SQL Server. The database recommendation is often based on two critical
customer requirements, support and cost. It is important to note that the support costs can sometimes be higher than the actual license costs.

Mail options: This service is essential for password reset, there is no admin page allowing you to force a new password, this would be a very big
no-no in security. It is critical to be able to "send" mail, receiving replies is not required.

Application ports & Instance options: For the external TomEE+ instance be sure that you have the proper OS permissions as the application may
need to add, alter or update binaries, libraries or configuration files.

386
3DSwym: Installation

Installation of 3DSwym GA comprises of below two elements.

Installing EXALEAD CloudView GA

3DSwym GA
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Installing 3DSwym Foundation


Installing 3DSwym Video Converter
Installing 3DSwym Index

387
3DSwym: Installing EXALEAD CloudView - GA Media Installer

GA core components have two different installation methodologies:

1. The “Global 3DEXPERIENCE platform Installer" found in:


<Media>\AM_3DEXP_Platform.AllOS\1\
Navigate to this path and find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

o GUI: setup.exe
o TUI: StartTUI.exe
This installer is primarily used when you want to deploy all the services on one machine

2. Classic Service Installer are available in :


<Media>\AM_3DEXP_Platform.AllOS\2\EXALEAD_CloudView\Windows64\1
Traditional method used to deploy the services on different machines

Start the Global 3DEXPERIENCE platform Installer installer for the training
Fields to complete are identical for the two installers.
Some of the parameters chosen with the initial service installer are presented in the subsequent installers as read -only.

388
EXALEAD CloudView : GA Media installer

In this exercise, you will:

 Install the GA EXALEAD CloudView


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

15 minutes

389
EXALEAD CloudView : GA Media Installer

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select the “NETVIBES EXALEAD CloudView" and click Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

390
EXALEAD CloudView GA : Key Parameters

During the Installation you will be queried about the following parameters:
Cheat-Sheet :

Steps Key Value

01 Global platform Installer <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

02 Global platform Installer NETVIBES EXALEAD CloudView

03 Installation Directory D:\3DEXPERIENCE\R2023x\CloudView

04 Install Embedded Java Kit No

05 64-bit JDK path D:\3DEXPERIENCE\Java64\jdk17

391
EXALEAD CloudView : GA Media Installer

1. It is strongly recommended that you copy the installation information into a text file prior to clicking Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable, can easily by


copied into report.

392
Exercise Recap: EXALEAD CloudView

1. In this exercise, you have:

 Installed the GA EXALEAD CloudView


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

393
3DSwym Foundation - GA Media Installer

GA core components have 2 different installation methodologies:

1. The “Global 3DEXPERIENCE platform Installer" found in:


<Media>\AM_3DEXP_platform.AllOS\1\
Navigate to this path and find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

o GUI: setup.exe
o TUI: StartTUI.exe

This installer is primarily used when you want to deploy all the services on one machine

2. Classic "Service Installer" are available in :


<Media>\AM_3DEXP_platform.AllOS\3\3DSwym\Windows64\1
Traditional method used to deploy the services on different machines

Start the “Global 3DEXPERIENCE platform Installer" installer for the training
Fields to complete are identical for the two installers
Some of the parameters chosen with the initial service installer are presented in the subsequent installers as read -only

394
3DSwym Foundation - GA Media Installer

In this exercise, you will:

a. Install the GA 3DComment


b. Perform the GA post configuration
c. Technical validation of the GA service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validate the GA service

30 minutes

395
3DSwym Foundation - GA Media Installer

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select the "3DSwym Service" and click Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

396
3DSwym Foundation - GA Media Installer

3. Components to Install 
a. 3DSwym Foundation
b. 3DSwym Video Converter
c. 3DSwym Index
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

397
3DSwym Foundation - GA Media Installer

4. Using the Cheat-sheet on the next page, proceed to the installation, don’t forget the installer options related to:
a. Installing the embedded JDK  No
b. Installing the embedded TomEE+  No
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

398
3DSwym Foundation : Key Parameters

During the Installation you will be queried about the following parameters:

Make sure to enter mytraining.com instead of mydomain. This


DNS is specific for this training and would vary in the real world.
Cheat-Sheet :
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Steps Key Value

01 Global platform Installer <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe

02 Global platform Installer "3DSwym Service"

03 Installation Directory D:\3DEXPERIENCE\R2023x\3DSwym

3DSwym Foundation
04 Select Components 3DSwym Video Converter
3DSwym Index

05 Install the embedded JDK No

06 JDK PATH D:\3DEXPERIENCE\Java64\jdk17

D:\3DEXPERIENCE\data\3DSwymData
07 Directory for Shared folder D:\3DEXPERIENCE\data\3DSwymLogs
D:\3DEXPERIENCE\data\3DSwymTmp

399
3DSwym Foundation : Key Parameters

1. Cheat-Sheet : (continued)

Steps Key Value

3DPassport URL https://3dpassport.mytraining.com:443/3dpassport

3dswym Fulltext Search http://3dswymindex.mytraining.com:29000


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DDashboard URL https://3ddashboard.mytraining.com:443/3ddashboard


08 3DCompass URL https://3dspace.mytraining.com:443/3dspace
6WTag service URL https://3dspace.mytraining.com:443/3dspace
3DSwym URL https://3dswym.mytraining.com:443/3dswym
3DComment URL https://3dcomment.mytraining.com:443/3dcomment
3DNotification URL https://3dnotification.mytraining.com:443/3dnotification
09 Install the embedded ApacheTomEE+ No

10 Apache TomEE Installation path D:\3DEXPERIENCE\TomEE\TomEE3DSwym

11 DB Selection Oracle or SQL Server

Directory of tnsnames.ora C:\app\dbadmin\network\admin

Net_Service_Net name for3DSwym Content X3DEXP


12
Oracle Net_Service_Net name for 3DSwym Rich
X3DEXP
Media

Net_Service_Net name for 3DSwym Widget X3DEXP

400
3DSwym Foundation : Key Parameters

1. Cheat-Sheet : (continued)

Steps Key Value

Database username for 3DSwym Content X3DSWYM


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Database user's password for 3DSwym Content X3DSWYM

12 Database username for 3DSwym Rich Media X3DSWYM_MEDIA


Oracle
Database user's password for 3DSwym Rich Media X3DSWYM_MEDIA

Database username for 3DSwym Widget X3DSWYM_WIDGET

Database user's password for 3DSwym Widget X3DSWYM_WIDGET

Database Host database.mytraining.com\X3DEXP:1433

x3dswym_social
Database name x3dswym_media
x3dswym_widget
12
SQL Database Administrator username x3dsm_admin
Server
Database Administrator user's password Passport#1

Database username x3dsm

Database user's password Passport#1

401
3DSwym Foundation : Key Parameters

1. Cheat-Sheet : (continued)

Steps Key Value

13 Use as batch Yes


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

6WTag administrator user admin_platform


14
6WTag administrator password Zaq1@WsxCde3

Mail Server name smtp.mytraining.com


15
Mail sender name [email protected]

16 Tools entries in start menu Yes

17 Choose the Certificate location D:\3DEXPERIENCE\conf\ssl

18 CloudView Admin Password Zaq1@WsxCde3

19 CloudView Data Directory D:\3DEXPERIENCE\R2023x\3DSwym\win_b64\datadir

402
3DSwym Foundation : Oracle Summary

It is strongly recommended that you copy the installation information into a text file prior to clicking Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

403
3DSwym Foundation : SQL Server Summary

It is strongly recommended that you copy the installation information into a text file prior to clicking Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

404
3DSwym : GA Post Installation

3DSwym installer does not immediately create the database objects, these objects are created during application startup. You will notice messages in
the TomEE+ logs about database tables already existing upon re-start of TomEE+.
The installer automatically puts the TomEE+ WAR file in the proper webapps folder.

a. TomEE+ code PATH: D:\3DEXPERIENCE\TomEE\TomEE3DSwym


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Start and stop TomEE+ (or use your Desktop icon) You may need to repeat once
<TomEE3DSwym>\bin\startup.bat this step in order to have a
Wait for it to finish deploying the application. proper "Server startup"
message.

<TomEE3DSwym>\bin\shutdown.bat
Wait for it to finish shutting down before closing the terminal.

c. Check the logs for any errors and delete the logs in the folder
<TomEE3DSwym>\logs\*.log

405
3DSwym : GA Post Installation

d. Go to your 3DEXPERIENCE folder and edit the file: D:\3DEXPERIENCE\conf\3dexperience.conf


In the 3DSwym section replace the line:
#XXXX Future fragment file XXXX
With  Include D:\3DEXPERIENCE\R2023x\3DSwym\win_b64\templates\3dswym_httpd_fragment.conf
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

e. Edit the fragment file:


D:\3DEXPERIENCE\R2023x\3DSwym\win_b64\templates\3dswym_httpd_fragment.conf
Update the values for "port" and "FQDN" are correct in the fragment. http://3dswym.mytraining.com:8780/

f. Make a backup of the fragment file named:


D:\3DEXPERIENCE\conf\Fragment\3dswym_httpd_fragment.conf.GA
g. Copy "UserIntentions_CODE.xml" file found in: D:\3DEXPERIENCE\R2023x\3DSwym\InstallData
To folder D:\3DEXPERIENCE\conf\UserIntentions\
and rename it to: UserIntentions_3dswym.xml

406
3DSwym : GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.
There are 2 validation steps: installer log and expected file deployment review.
Code Installation Path <Code Path> = D:\3DEXPERIENCE\R2023x\3DSwym

1. Installer error log should be 0 bytes and can be found at:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_SWYM.media\Errors.log & *Stderr.txt


Size should be 0 bytes
If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

2. Expected file and/or folder creation:


1. <TomEE3DSwym>\webapps\3dsearch.war
2. <TomEE3DSwym>\webapps\3dswym.war
3. <TomEE3DSwym>\webapps\uwp.war
4. <TomEE3DSwym>\bin\setenv.bat

407
EXALEAD CloudView : Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. Check the Service Status

1. Restart the "Apache2.4" Service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

2. Restart the Service if not automatically started.

408
3DSwym: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Redirect to 3DSwym TomEE+ after Passport authentication

1. Start TomEE+ (3DSwym + 3Dpassport)


a. < 3Dpassport>\bin\startup.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Each time you test a new


b. <TomEE3DSwym>\bin\startup.bat
URL bookmark it in Firefox.
Wait for it to finish deploying the application.
Access the MyURLs.html or https://3dswym.mytraining.com/3dswym

MyURLs.html

409
Exercise Recap: 3DSwym

1. In this exercise, you have:

 Installed the GA 3DSwym


 Performed the GA post configuration
 Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Validated the EXALEAD CloudView GA service


 Validated the 3DSwym GA service

410
3DSwym: Uninstallation

Windows normal uninstall procedure:

Stop TomEE+ if it is running <Service Name>

In the Database instance drop the 2 schemas / databases.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

In "Programs and Features" uninstall:


"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

Or the Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

d. Remove the folder


D:\3DEXPERIENCE\R2023x\<Service Name>
D:\3DEXPERIENCE\TomEE\TomEE<Service Name>

411
FCS

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform
installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE platform
About FCS Central

The File Collaboration Server (FCS) enables administrators to distribute file data across the enterprise for optimal upload a nd download
performance. It provides location, checkout, and copy operations for the data managed by the 3DSpace Service.

The "central" FCS replaces the embedded FCS in the 3DSpace installation. It is recommended to offload the FCS functionality t o a dedicated server
allow 3DSpace to concentrate on serving the application pages rather than delivering files. This standalone "FCS" is referred as the "Central FCS".
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

413
FCS Central: Architecture

Reverse proxy*
Apache HTTPD
(HTTP/HTTPS)
Load Balancer
(HAProxy)
Operating System
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

(Windows/Linux)

Failover
Legend :

Machine Front End*

DS FCS
Component’s Application Server (TomEE+)
DS Services Java Development Kit (JDK)
3rd party Operating System (Windows/Linux)
Component's
Load-balanced
Optional

HTTP(S)
HTTP(S)
HTTP(S)
Store*
NFS
NFS (SAN/NAS)
Operating System
SQL (Windows/Linux)
3DSpace HTTP(S) FCS
Failover

* Always Refer the "Program Directory" for version and latest news.

414
Check-in Process

Web Client 3DSpace 3DSpace DB FCS

Pre-check-in
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Msg check-in ticket


(No OID, Format) File upload and ticket for checksum (*)

Check-in receipt with checksum Calculate


checksum
Check-in msg: checkin Metadata insert with checksum
receipt with checksum
Msg check-in OK
Check-in OK

415
Check-out Process

Web Client 3DSpace 3DSpace DB FCS


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Call Check-out with OID(s),


Format(s), and filename(s)

Return Location/Store/Site
Return jobTicket with checksum
Send jobTicket with checksum for check-out
Calculate current
checksum and
Content download (or error report) compare with
ticket checksum

416
FCS Central: Pre-Check

You should have already prepared the required details to proceed with this service installation, you will need the following pre-requisites:

TomEE+ (stopped)
1 TomEE+ is dedicated for the service
1 SSL certificate
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Java

You will not be able to proceed if any of these are missing.

Main Configuration requirement:


Database objects : No
TomEE+ needed : Yes
Java dependent : Yes

417
FCS: Key Parameters

Installation "Cook-book" : Installation key parameter explained.

Keywords: FCS file repository, crawler & user.

"Installation Directory": This is the location where the service code will be installed. Do not use blanks in the installatio n path if you can avoid it. It is
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

also recommended not to install on the "C:\" drive. The "C:\" drive is the system drive, if it gets corrupted or becomes full it could bring the service
down. By selecting another drive you will have better control and stability for the platform.

"Append service binary to PATH": This allows the OS and users "easier" access to the FCS binaries but it is not recommended because it may
interfere with other applications. The preferred solution is to set the PATH variable in the TomEE+ environment variables and to set it in any batch
that you would like to execute.

"Web Application name": Name of the war file that will be created, it is recommended to keep the default value, "fcs". Typically SSL terminates at
the F5 or apache which sends the requests to the backend FCS JVM host name and ports like so:
Endpoint URL
https://fcs.mytraining.com/fcs
Backend JVMs
http://realhostname.domain.com:8081/fcs
http://realhostname.domain.com:8082/fcs

418
FCS Central : GA Media Installer

The "Global 3DEXPERIENCE platform Installer" is not available for the FCS.

"Service Installer" will be used for this service :


<Media>\AM_3DEXP_Platform.AllOS\4\FileCollaborationServer\
oFileCollaborationServer-V6R2023x.Windows64.zip
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Select the media and extract it into a temporary location:


o<Installers>\FileCollaborationServer.Windows64\1

As with the global 3DEXPERIENCE platform installer, you have the GUI and TUI options
oGUI: setup.exe
oTUI: StartTUI.exe
o
Based on your preference, start the installer

419
Exercise: FCS Central

In this exercise, you will:

a. Install the GA FCS Central


b. Perform the GA post configuration
c. Technical Validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validate the GA service

10 minutes

420
FCS Central - GA Media Installer

1. Launch the Classic Installer for File Collaboration Server.


NOTE - FCS installation is quite simple. If multiple FCSs are needed they can be installed in parallel or even prior to any other server core component.
FCS installation is easy to replicate, using the user intention file.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

421
FCS Central : GA Media Installer

1. Using the Cheat-sheet on the next page proceed to the installation, don’t forget the installer options related to:
Install the embedded JDK  No
Install the embedded TomEE+  No
Append server binary directory to System PATH  No
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

422
FCS Central: Key Parameters

During the Installation you will be queried about the following parameters:

Make sure to enter mytraining.com instead of mydomain. This


DNS is specific for this training and would vary in the real world.
Cheat-Sheet:
Steps Key Value
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

01 Installer location <Media>\AM_3DEXP_Platform.AllOS\1\FileCollaborationServer

02 Service Installer Setup.exe

03 Installation Directory D:\3DEXPERIENCE\R2023x\FCSCentral

04 JDK PATH D:\3DEXPERIENCE\Java64\jdk17

05 Install the embedded JDK No

06 Install the embedded Apache TomEE+ No

07 Apache TomEE+ Installation path D:\3DEXPERIENCE\TomEE\TomEEFCSCentral

FCS Service URL https://fcscentral.mytraining.com:443/fcs


08
Metadata server service URL https://3dspace.mytraining.com:443/3dspace

Append server binary directory to System


09 No
PATH

There is no need to change the default "fcs" "Application Name" since each FCS will be in its own.
423
FCS Central: GA Media Installer

1. It is strongly recommended that you copy the installation information into a text file prior to clicking the "install" button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

424
FCS Central: GA Post Installation

FCS installer requires some preparation.

a. Start and stop TomEE+ (or use the Desktop icon)


<TomEEFCSCentral>\bin\startup.bat, wait for it to finish deploying the application…
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. <TomEEFCSCentral>\bin\shutdown.bat
Wait for it to finish shutting down the application properly before closing the terminal …

c. Check the logs for any error and Clean log folder
<TomEEFCSCentral>\logs\*.log

425
FCS Central : GA Post Installation

d. Go to your 3DEXPERIENCE folder and edit the file: D:\3DEXPERIENCE\conf\3dexperience.conf In the


In the section "FCSCentral" replace the line: #XXXX Future fragment file XXXX
With:
include D:\3DEXPERIENCE\R2023x\FCSCentral\win_b64\templates\fcs_httpd_fragment.conf
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Make sure to use the fragment as it contains the correct Cross Origin Resource Sharing (CORS) configuration.

d. Copy the "UserIntentions_CODE.xml" file in folder


D:\3DEXPERIENCE\R2023x\FCSCentral\InstallData
To folder: D:\3DEXPERIENCE\conf\UserIntentions\
and rename it to: UserIntentions_FCSCentral.xml

426
FCS Central : GA Post Installation

f. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\FCSCentral\win_b64\templates\fcs_httpd_fragment.conf
Update the values of the "port" and "FQDN" in the fragment file.
http://fcscentral.mytraining.com:8880/fcs
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Make sure that the CORS (Cross-Origin Resource Sharing) is activated for the FCS.

Observe that the contents of the CORS header declaration are also in the fragment file.

427
FCS Central : GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.
There are 2 validation steps: installer log, database and expected file deployment review.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\FCSCentral


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. Installer error log should be 0 bytes and can be found at:


<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_ENOVIA_FCS.media\Errors.log & *Stderr.txt
Size should be 0 bytes

If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

2. Expected file and/or folder creation:


<TomEEFCSCentral>\webapps\fcs.war
<TomEEFCSCentral>\bin\setenv.bat

428
FCS Central : Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. FCS Central TomEE+
Each time you test a new URL
1. Restart the "Apache2.4" Service bookmark it in Firefox.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

2. Start TomEE+
a. <TomEEFCSCentral>\bin\startup.bat
Wait for it to finish deploying the application…
Access the MyURLs.html or https://fcscentral.mytraining.com:443/fcs/servlet/fcs/about
MyURLs.html

429
FCS Central: Uninstallation

Windows normal uninstall procedure:

a. Stop TomEE+ if it is running <Service Name>

b. In "Programs and Features" uninstall:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

Or the Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

c. Remove the folders:


I.D:\3DEXPERIENCE\R2023x\<Service Name>
II.D:\3DEXPERIENCE\TomEE\TomEE<Service Name>

430
Exercise Recap: FCS Central

1. In this exercise, you have:

 Installed the GA FCS Central


 Performed the GA post configuration
 Technical validation of GA Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Validated the GA service


2.

431
Notes: About FCS Remote

The File Collaboration Server (FCS) enables administrators to distribute file data across the enterprise for optimal upload a nd download
performance. It provides location, checkout, and copy operations on the data managed by the 3DSpace Service.

The Remote FCS is designed for remote users. A remote user is a user that access the application from a location separated b y a significant
difference from the data center hosting the 3DEXPERIENCE platform. Having an FCS near the end user allows for faster access to files when
compared to pulling them across large distances over slow network links. It is usually recommended to have an FCS at a remote location if file
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

access or the network is slow.

432
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Notes: About FCS Remote

433
3D Indexing Server

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE platform
Introduction

At this point you should now have installed all the server core elements and validated them.

This chapter will introduce the "3D Indexing Server" component and discuss configuration options and key parameters you need to manage for your
installation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

With the 3DEXPERIENCE platform R2023x 3D Indexing Server is still separate from 3DSearch and still uses its own installer.

435
About 3D Indexing Server

The purpose of the 3D Indexing Server is to generate 3D thumbnails to allow 3D searching from a native Client such as CATIA, DELMIA or
SIMULIA.

For production environments you would typically install 3DSpace and 3D Indexing Server on different machines.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

For best performance, the generated index files should be located on the same machine as the 3D Indexing Server.

Installing the 3D Indexing Server will include the 3DIndex Engine (3DSpace side).

436
About Indexing Content

When you are navigating and exploring the structure of your objects, the 2D thumbnails will help you quickly locate the conte nt you are searching
for. 3D thumbnails are visible in the Preview window when you consult the properties of the content.

For intermediate nodes, you have two options: either you use the Dynamic 3D Thumbnail feature from the Native App or you can generate static 2D
and 3D Thumbnails using the Thumbnail builder.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

437
3DIndex Server

https
Native Client such as CATIA 3DPassport

1
Volume Queries
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Check out 2D & 3D


thumbnails Get objects
https 3DSpace to index
(NO-CAS) 3DSpace
DB
Check out CGR Retrieve list of 1
http 1 2 http/https
representation to index 2 objects
3DIndex Server MQL Crawler
FCS with File
Converter
http (Thumbnail 3DSpace Index
generation)
Check in 2D & 3D 3
thumbnails objects
octree

Indexation Build time


Indexation Run time

Thumbnails generation

438
3D Indexing Server: Pre-Check

You should have already prepared the required details to proceed with this service installation, you will need the following pre-requisites:

3DEXPERIENCE platform:-3DSpace Internal (No-CAS) should be installed and running.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

439
3DEXPERIENCE platform: Global 3DXPERIENCE platform Installer

You will use the "Global 3DEXPERIENCE platform Installer" located on the following media: AM_3DEXP_platform.AllOS

The folder structure of the media is as follows: 1, 2, 3, 4, 5, 6, 7, 8, 9 ,10,11, 12, 13, 14, 15, 16 and 17
The "global 3DEXPERIENCE platform installer" is present under folder "1"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Two interactive installations are available:


Graphical User Interface (GUI)
Text User Interface (TUI)

It will be up to you to select the services that you will install in the current server. In the training you are proceeding o ne by one.

440
3D Indexing Server : Key Parameters

Installation Cook-book: Installation key parameter explained.

Keywords : 2D/3D thumbnails

Installation Directory: This is the location where the service code will be installed. Do not use blanks in the installation path if you can avoid it. It is
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

also recommended not to install on the C:\ drive. The C:\ drive is the system drive, if it gets corrupted or becomes full it could bring the service
down. By selecting another drive you will have better control and stability for the platform.

3DSpace server path: The 3DIndex installer assumes you are installing the component on the same server as 3DSpace. If that is the case then no
additional changes are required.

Temporary Settings Path for 3DSpace Server: If you are installing 3DIndex on a different server from 3DSpace you will need to create an empty
folder structure that mimics 3DSpace. You do not need all the folders in 3DSpace, the installer will throw an error if something is missing. After the
installer completes you will have to copy the created files in the temporary 3dspace folders to the real 3DSpace server. You will have to make sure
you update all the files in 3DSpace including the webapp and STAGING directories otherwise your updates may "disappear" when you rebuild the
WAR files.

3DSpace connection parameters: Since 3D Indexer is a batch tool it is recommended to use the 3DSpace internal webapp (NoCAS). Normally you
can use HTTP instead of HTTPS for the NoCAS Server.

3DIndexAdminUser: A 3D Indexer admin user is required, be aware that this user will consume a platform License. This built in user has special
privileges, do not use the admin_platform user for 3DIndex administration as they have different purposes and roles. It is recommended to use a
strong password for the 3DIndexAdminUser since it is not typically controlled by 3DPassport or LDAP.

441
3D Indexing Server: Configuration and Key Parameters

Main Configuration requirements:

Database objects :No


TomEE+ needed :No
Java dependent :No
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

442
3D Indexing Server : GA media installer

GA core components have two different installation methodologies:

Navigate to the “Global 3DEXPERIENCE platform Installer" found in:


<Media>\AM_3DEXP_platform.AllOS\1\
o GUI: setup.exe
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

o TUI: StartTUI.exe

Classic "Service Installer" are available in:


<Media>\AM_3DEXP_Platform.AllOS\3\3DIndexingServer\Windows64\1

Based on your preference:


Start the installer

443
Exercise: 3D Indexing Server

In this exercise, you will:

a. Install the GA 3D Indexing Server


b. Technical Validation of GA Service
c. Validate the GA service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

20 minutes

444
Exercise: 3D Indexing Server

1. Start the 3DEXPERIENCE Platform Global Installer: <Media>\AM_3DEXP_Platform.AllOS\1\setup.exe


2. Select the "3D Indexing Server" and click Install.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

445
3D Indexing Server: Configuration & Key Parameters

During the Installation you will be queried about the following parameters:

Cheat-Sheet :

Steps Key Value


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

01 Global platform Installer <Media>\AM_3DEXP_platform.AllOS\1\setup.exe

02 Global platform Installer 3D Indexing Server

03 Installation Directory D:\3DEXPERIENCE\R2023x\VolumeSearch

04 Tools Entries in Start Menu Yes

Server name internal.mytraining.com

Server Port number 8480

Server RootURI internal

05 Indexing User 3DIndexAdminUser

Indexing user Password Zaq1@WsxCde3 Note: it’s the MQL password

Indexing user security context VPLMAdmin.Company Name.Default

Index Directory D:\3DEXPERIENCE\data\3DIndexes

06 Creates shortcuts for 3DIndex tools Yes

446
3D Indexing Server : GA media installer

1. It is strongly recommend that you copy the installation information into a text file prior to clicking the Install button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

447
3D Indexing Server: GA Technical Validation

"GA technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.

Target installation PATH: D:\3DEXPERIENCE\R2023x\VolumeSearch

1. Installer error log should be 0 bytes and can be found at:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_ENOVIA_PIX.media\Errors.log & *Stderr.txt


Size should be 0 bytes

If you had to modify values in the installer dialogues you will see these errors
in the Errors.log you will need to validate if any of these messages require
corrective action.

2. Three icons will be created on your desktop:


3DIndex Environment Administration
Data re-indexation batch
IndexationReport.html

448
3D Indexing Server: GA Technical Validation

1. The following entries will be added to the Start > All Programs menu:

a. Dassault Systemes 3DEXPERIENCE R2023x 3D Index Server > Tools


i. 3D Index Environment Administration
ii. Data Re-indexation batch
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

iii. Environment Editor

2. Logging in with another user not only affects the visibility of shortcuts and menu items but it may also prevent you from running 3DEXPERIENCE
programs because of the following.
a. Security :The ownership of the files and folder (editing, visibility).
b. Scheduler Task : running job like (start/stop/modify); Indexer backup, clean, optimization, etc…
c. For the purposes of training, all of these components need to be under one Authority.

449
Exercise Recap: 3D Indexing Server

1. In this exercise, you have:

 Installed the GA 3D Indexing Server


 Technical Validation of GA Service
 Validated the GA service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

450
Diagnosing 3DEXPERIENCE platform

Topics to be covered:

1. Introduction
2. DSLS
3. Global 3DEXPERIENCE platform Installer
4. 3DPassport
5. Reconfiguration
6. 3DDashboard
7. 3DSearch
8. 3DSpaceIndex
9. 3DSpace
10. 3DNotification
11. 3DComment
12. 3DSwym
13. FCS
14. 3D Indexing Server
15. Diagnosing 3DEXPERIENCE platform
Diagnosing the 3DEXPERIENCE Platform

The diagnostic tool allows you to check that, after a COMPLETE installation and deployment of your 3DEXPERIENCE platform, comprising all
mandatory services, that the platform is up and running.

The services for which the diagnostic tool is supported are:


3DPassport
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DDashboard
3DSearch
3DSpace and 3DSpace Index
3DSwym
3DComment
3DNotification.

3D Indexing Server and Monitoring Agent and Probes are not supported in diagnostic mode.

Note: As a exercise, the Diagnostic tool will be executed on 3DSpace service for demonstration.

452
Exercise: Diagnosing the 3DEXPERIENCE Platform

1. In this exercise, you will:

a. Diagnosing the 3DEXPERIENCE platform Installation : Execution


b. Reading the HTML file.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

10 minutes

453
Diagnosing the 3DEXPERIENCE platform Installation : Execution

The diagnostic tool allows you to check that, after a complete installation and deployment of your 3DEXPERIENCE platform, comprising all mandatory
services, that the platform is up and running.
1. Launch the command prompt.
2. Change to the service installation directory.
The tool has to be run from the “command” folder of each service (in this case 3DSpace), in the following directory:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\code\command
3. Execute the following command: run_test.bat

454
Diagnosing the 3DEXPERIENCE platform Installation

1. The tool reads the UserIntentions_CODE.xml file that saves the 3DEXPERIENCE Configuration Specifications used during the installation
(Security, URL connections, Prerequisites, Directories, Read / Write access, Mail server access etc.).

2. If you have upgraded/reconfigured the software, the tool will read the last UserIntentions_CODE.xml created.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

455
Diagnosing the 3DEXPERIENCE platform Installation

1. The HTML results look like this:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

456
Diagnosing the 3DEXPERIENCE platform Installation

5. The generated results are available in the folder indicated by the url in your browser on Windows or in the path displayed by the console.

 <%TEMP% of user>\Diagnosis\ on Windows


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

6. If the results show errors, click on the link in Detailed results

457
Exercise Recap: Diagnosing the 3DEXPERIENCE platform Installation

1. In this exercise, you have:

 Executed the Diagnosing of the 3DEXPERIENCE platform Installation


 Reading the HTML file.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

458
Summary

Core Configuration

In this lesson, you have installed the core components:


 3DPassport
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 3DDashboard
 3DSearch (Federated Search)
 3DSpace Index
 3DSpace
 3DNotification
 3DComment
 3DSwym
 FCS Central

459
Lesson 6: Hot Fix Installation of all Services

Introduction
3DPassport
3DDashboard
3DSearch
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DSpaceIndex
3DSpace
CSV Apps
3DNotification
3DComment
3DSwym
FCS Central
3DIndex Server

8 hours

460
Introduction

During a release life cycle, Dassault Systèmes provides fix packs to fix issues or deliver new and enhanced features.

A fix pack is a package of components called hot fixes (referred to as HF in the rest of this section).

Do not confuse updating using HFs with upgrading. Upgrading means moving to the next GA level.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

461
About Hot Fix

Updating the 3DEXPERIENCE platform involves installing all the HFs in a given a fix pack and impacting the 3DEXPERIENCE platform
components already installed.

This is the only way to guarantee that they will be compliant with each other. Therefore, this is the only supported configur ation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The HF media must always be installed in the same directory as the GA version.

A HF installation is always performed in "delta" mode. This means that the HF media does not contain all files: it contains o nly the files that are
different from the previous HF or from the GA level of the same version.

HFs are cumulative : there is no need to install all HF versions until the required HF version. For example, it is possible t o install the GA, then HF4,
then HF5 (without installing the intermediary HF1, HF2 and HF3 hot fixes).

462
3DPassport

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
Exercise: 3DPassport

In this exercise, you will:

a. Install the 3DPassport FP Service


b. Perform the post install configuration
c. Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Functional Validation the FP service

15 minutes

464
3DPassport: FP Service Installer

There is no "Global 3DEXPERIENCE platform Installer" for FP you must each service individually.

a. Ensure that "TomEE3DPassport" is stopped


D:\3DEXPERIENCE\TomEE\TomEE3DPassport\bin\shutdown.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

If you do not stop TomEE+, the installer will not be able to replace certain files automatically, this can result in errors in the log or unexpected behavior.

b. Use the normal "Service Installer":


<Media>\Part_3DEXP_Platform.Windows64\1\Software
You will find:
3DPassport-V6R2023x.HF1.Windows64.zip

c. Unzip the proper OS version to <Your Installer PATH>


<Installers>\3DPassport.Windows64\1

d. Navigate to this path and find:


I.GUI: setup.exe
II.TUI: StartTUI.exe

465
3DPassport: FP Service Installer (Oracle Summary)

Proceed with the update using the same key values as GA.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

Notice that some of the values are already entered for you.

466
3DPassport: FP Service Installer (SQL Server Summary)

Proceed with the update using the same key values as GA.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

Notice that some of the values are already entered for you.

467
3DPassport: FP Post Installation

a. TomEE code path: D:\3DEXPERIENCE\TomEE\TomEE3DPassport

b. Start and stop TomEE+ (or use your Desktop icon)


<TomEE 3DPassport>\bin\startup.bat
Wait for it to finish deploying the application.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\3DPassport\win_b64\templates\3DPassport_httpd_fragment.conf
Update the values for "port" and "FQDN" in the fragment file.
http://3dpassport.mytraining.com:8080/3dpassport

d. Backup the fragment file to:


D:\3DEXPERIENCE\conf\Fragment\3DPassport_httpd_fragment.conf.FP

468
3DPassport: FP Technical Validation

1. "FP technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.
There are 2 validation steps: installer log and expected file deployment review.

2. Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DPassport


Installer error log should be empty in:
<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_PASS.media\Errors.log & *Stderr.txt
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Size should be 0 byte

You should see 2 "…media…" folders, one for the GA and a new one for the FP.

If you had to modify values in the installer dialogues you will see these errors in
Errors.log you will need to validate if any of these messages require corrective action.

2. Expected file creation or updates, have a look:


a. <TomEE 3DPassport>\webapps\3dpassport.war
b. <TomEE 3DPassport>\bin\setenv.bat

469
3DPassport: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. 3DPassport TomEE+
1. Restart the "Apache2.4" Service
a. Open service manager
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Start TomEE+
a. <TomEE 3DPassport>\bin\startup.bat
b. Access the MyURLs.html or Each time you test a new URL
https://3dpassport.mytraining.com:443/3dpassport bookmark it in Firefox.

MyURLs.html

470
3DPassport: Validation

Perform the following actions: Connect to 3Dpassport

a. Connect with user admin_platform and password Zaq1@WsxCde3


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. You can click Log out.

471
Exercise Recap: 3DPassport

1. In this exercise, you have:

 Installed the FP for 3DPassport


 Performed the post FP configuration
 Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Functional Validation the FP service

472
3DDashboard

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
Exercise: 3DDashboard

In this exercise, you will:

a. Install the 3DDashboard FP Service


b. Perform the post install configuration
c. Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Functional Validation the FP service

15 minutes

474
3DDashboard : FP Service Installer

There is no "Global 3DEXPERIENCE platform Installer" for FP you must each service individually.

a. Ensure that "TomEE 3DDashboard" is stopped


D:\3DEXPERIENCE\TomEE\TomEE3DPassport\bin\shutdown.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

If you do not stop TomEE+, the installer will not be able to replace certain files automatically, this can result in errors in the log or unexpected behavior.

b. Use the normal "Service Installer":


<Media>\Part_3DEXP_Platform.Windows64\2\Software\
You will find:
3DDashboard-V6R2023x.HF1.Windows64.zip

c. Unzip the proper OS version to <Your Installer PATH>


<Installers>\3DDashboard.Windows64\1

d. Navigate to this path and find:


I.GUI: setup.exe
II.TUI: StartTUI.exe

475
3DDashboard : FP Service Installer (Oracle Summary)

Proceed with the update using the same key values as GA.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

Notice that some of the values are already entered for you.

476
3DDashboard : FP Service Installer (SQL Server Summary)

Proceed with the update using the same key values as GA.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

Notice that some of the values are already entered for you.

477
3DDashboard: FP Post Installation

3DDashboard installer immediately creates the database objects during the installation procedure rather than at TomEE+ startup, you can immediately
validate the tables have been created.

a. TomEE+ PATH: D:\3DEXPERIENCE\TomEE\TomEE3DDashboard


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Start and stop TomEE+ (or use you Desktop icon)


<TomEE 3DDashboard>\bin\startup.bat
Wait for it to finish deploying the application.

c. Edit the fragment file:


D:\3DEXPERIENCE\R2023x\3DDashboard\win_b64\templates\3DDashboard_httpd_fragment.conf
Update the values for "port" and "FQDN" in the fragment file.
http://3ddashboard.mytraining.com:8180/3ddashboard

d. Backup the fragment file to:


D:\3DEXPERIENCE\conf\Fragment\3DDashboard_httpd_fragment.conf.FP

478
3DDashboard : FP Technical Validation

"FP technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.
There are two validation steps: installer log and expected file deployment review.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DDashboard


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. Installer error log should be empty in:


<Code>\InstallData\log\CODE\win_b64\<Latest timestamp>-0000_CODE_win_b64_X3D_DASH.media\
Errors.log & *Stderr.txt
Size should be 0 bytes

You should see 2 "…media…" folders, one for the GA and a new one for the FP.
If you had to modify values in the installer dialogues you will see these errors in
Errors.log you will need to validate if any of these messages require corrective action.

2. Expected file creation or updates, have a look:


<TomEE 3DDashboard>\webapps\3DDashboard.war
<TomEE 3DDashboard>\bin\setenv.bat

479
3DDashboard: Validation

1. In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. Redirect to 3DDashboard TomEE+ after Passport Authentication

2. Restart the "Apache2.4" Service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

3. Start TomEE+ Each time you test a new URL


a. <TomEE 3DDashboard>\bin\startup.bat bookmark it in Firefox.

4. Access the MyURLs.html or https://3ddashboard.mytraining.com:443/3ddashboard MyURLs.html


5. 3DDashboard depends on 3DSpace which is not yet installed. the expected behavior is
a. 3DDashboard redirects to 3DPassport via Apache
b. After 3DPassport authentication, redirected back to "3DDashboard" via Apache

480
Exercise Recap: 3DDashboard

1. In this exercise, you have:

 Installed the FP for 3DDashboard


 Performed the post FP configuration
 Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Functional Validation the FP service

481
3DSearch

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
Exercise: 3DSearch

1. In this exercise, you will:

a. Install the 3DSearch FP Service


b. Perform the post install configuration
c. Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Functional Validation the FP service

15 minutes

483
3DSearch: FP Service Installer

There is no “Global 3DEXPERIENCE platform Installer" for FP you must update each service individually.

a. Ensure that "TomEEFedSearch" is stopped


D:\3DEXPERIENCE\TomEE\TomEEFedSearch\bin\shutdown.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

If you do not stop TomEE+, the installer will not be able to replace certain files automatically, this can result in errors in the log or unexpected behavior.

b. Use the normal "Service Installer":


<Media>\Part_3DEXP_Platform.Windows64\3\Software
You will find:
o FederatedSearchFoundation-V6R2023x.HF1.Windows64.zip

c. Unzip the proper OS version to <Your Installer PATH>


o <Installers>\FederatedSearchFoundation.Windows64\1

d. Navigate to this path and find:


GUI: setup.exe
TUI: StartTUI.exe

484
3DSearch: FP Service Installer

1. It is recommended that you log the Installation Overview window containing your input values.
a. If you choose to take a screen shot, the window can be resized so you can see all the values clearly.
b. Proceed with the update using the same key values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

485
3DSearch: FP Post Installation

1. 3DSearch does not connect to a database or create database objects. A clean startup of TomEE+ is required after installation.

a. TomEE+ code PATH: D:\3DEXPERIENCE\TomEE\TomEEFedSearch

b. Start and stop TomEE+ (or use you Desktop icon)


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<TomEE FedSearch>\bin\startup.bat
Wait for it to finish deploying the application.

c. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\FedSearch\win_b64\templates\federated_httpd_fragment.conf

d. Update the values for "port" and "FQDN" in the fragment file.
http://3dsearch.mytraining.com:8280/federated

e. Backup the fragment file to:


D:\3DEXPERIENCE\conf\Fragment\federated_httpd_fragment.conf.FP

486
3DSearch: FP Technical Validation

"FP technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.
There are two validation steps: installer log and expected file deployment review.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\FedSearch


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. Installer error log should be empty in:


<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_SEAR.media\Errors.log & *Stderr.txt
Size should be 0 bytes
You should see 2 "…media…" folders, one was for the GA, the new one is the FP.

2. if you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

3. Expected folder creation or updates:


a. <TomEE FedSearch>\webapps\federated.war

487
3DSearch: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. Redirect to 3DSearch after 3DPassport authentication

1. Restart the "Apache2.4" Service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

2. Start TomEE+
Each time you test a new URL
a. <TomEE 3DPassport>\bin\startup.bat
bookmark it in Firefox.
b. <TomEE FedSearch>\bin\startup.bat
Wait for it to finish deploying the application.
MyURLs.html
Access MyURLs.html or https://3dsearch.mytraining.com:443/federated
a. 3DSearch has no user interface, the expected behavior is:
HTTPS URL access
Apache Found the URL
Redirected by Federated (3DSearch) to 3DPassport via Apache
3DPassport Authentication
Redirected back by 3DPassport to "federated" via Apache resulting in page not found (404 error).

488
Exercise Recap: 3DSearch

1. In this exercise, you have:

 Installed the FP for 3DSearch


 Performed the post FP configuration
 Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Functional Validation the FP service

489
3DSpaceIndex

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
Exercise: 3DSpaceIndex

In this exercise, you will:

a. Install the 3DSpaceIndex FP Service


b. Perform the post install configuration
c. Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Functional Validation the FP service

15 minutes

491
3DSpace Index: FP Service Installer

There is no “Global 3DEXPERIENCE platform Installer" for FP you must update each service individually.

a. Ensure that "3DSpace Index" service is stopped

b. Use the normal "Service Installer":


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Media>\Part_3DEXP_Platform.Windows64\2\Software
You will find:
3DSpaceIndex-V6R2023x.HF1.Windows64.zip

c. Unzip the proper OS version to <Your Installer PATH>


<Installers>\3DSpaceIndex.Windows64\1

d. Navigate to this path and find:


GUI: setup.exe
TUI: StartTUI.exe

492
3DSpace Index: FP Service Installer

As with GA, it is recommended that you log the Installation Overview window containing your input values.
If you choose to take a screen shot, the window can be resized so you can see all the values clearly.
Proceed with the update using the same key values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

493
3DSpace Index: FP Post Installation

3DSpace Index Fix Pack does not require any post installation manipulation at this time. This does not mean the application is functional however.

A Fix Pack will always require Post configuration of the config.xml file, it is possible that this file was updated with the FP and you will need to validate if
this has happened. Any 3DSpace Index FP installation will require a new FULL Indexation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Both of those actions can only be done when the entire 3DEXPERIENCE platform has been fix packed and is up and running. FP Install for 3DSpace
Index will therefore be executed in the "general POST 3DEXPERIENCE platform installation" procedure.

If the 3DSpace Index server is not in the same machine as 3DSpace, which is often the
recommended case, it’s beneficial for the 3DSpace Index server to have the MQL client
installed directly on the 3DSpace Index. It cuts down on a network hop when building the
3DSpace Index.

494
3DSpace Index: FP Technical Validation

"FP technical validation" refers to validation of the installation process, that is, did it install without errors and did it complete what it was supposed to do.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DSpaceIndex

1. Installer error log should be empty in:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_ENOVIA_SXI.media\Errors.log & *Stderr.txt


Size should be 0 bytes

Note: You should see 2 "…media…" folders, one was for the GA, the new one is the FP.

If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

495
3DSpace Index: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
Service
Access to the Administration page
1. Start the 3DSpaceIndex service if not already running Each time you test a
new URL bookmark
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

it in Firefox.

2. Access the MyURLs.html or http://3dspaceindex.mytraining.com:19001/index.html

MyURLs.html

496
3DSpace Index: Validation

3. In the web page select the Administration console.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Connect with user admin, password: Zaq1@WsxCde3


You should see:

497
Exercise Recap: 3DSpaceIndex

1. In this exercise, you have:

 Installed the FP for 3DSpaceIndex


 Performed the post FP configuration
 Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Functional Validation the FP service

498
3DSpace

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
CSV Apps : Interim

At this point you have finished the GA 3DSpace core components and CSV Apps GA Apps installation.

You will now need go to the 3DSpace service FP installation section of the Core Configuration document and complete the 3DSpace FP install.

When you have completed the 3DSPace FP installation you can come to this point and continue the FP installation for the CSV A pps applications.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

It is recommended that you install the CSV Apps FPs in the same order you installed the GA Apps

Not all Applications will have a Hotfix associated with the Fix Pack, some may remain at the GA level.

500
Exercise: 3DSpace

1. In this exercise, you will:

a. Install the 3DSpace FP Service


b. Perform the post install configuration
c. Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Install 3DExplore FP
e. Validation of 3DExplore Service

30 minutes

501
3DSpace: FP Service Installer

There is no Global 3DEXPERIENCE platform Installer for FP, you must update each service individually.

a. Ensure that TomEE+3DSpace is stopped


D:\3DEXPERIENCE\TomEE\TomEE3DSpace\bin\shutdown.bat
D:\3DEXPERIENCE\TomEE\TomEE3DSpaceInternal\bin\shutdown.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

If you do not stop TomEE+, the installer will not be able to replace certain
files automatically, this can result in errors in the log or unexpected behavior.

b. Use the normal "Service Installer":


<Media>\Part_3DEXP_platform.Windows64\2\Software\
You will find:
3DSpace-V6R2023x.HF1.Windows64.zip

c. Unzip the proper OS version to <Your Installer PATH>


<Installers>\3DSpace.Windows64\1

d. Navigate to this path and find:


GUI: setup.exe
TUI: StartTUI.exe

502
3DSpace: FP Service Installer

As with GA, it is recommended that you log the Installation Overview window containing your input values.
a. If you choose to take a screen shot, the window can be resized so you can see all the values clearly.
b. Proceed with the update using the same key values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable, can easily by


copied into report.

503
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DSpace: FP Service Installer

504
3DSpace: FP Post Installation

3DSpace creates the database objects during the installation phase.

a. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\templates\3DSpace_httpd_fragment.conf
b. Update the values for "port" and "FQDN" in the fragment file.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

http://3dspace.mytraining.com:8380/3dspace
http://internal.mytraining.com:8480/internal
c. Backup the fragment file to:
D:\3DEXPERIENCE\conf\Fragment\3DSpace_httpd_fragment.conf.FP

505
3DSpace: FP Technical Validation

FP technical validation refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DSpace

1. Installer error log should be empty in:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_CSMA.media\Errors.log & *Stderr.txt

Size should be 0 bytes


You should see 2 "…media…" folders, one for GA and a new one for the FP.

If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

2. Expected file creation or updated:


<TomEE3DSpace>\bin\setenv.bat

506
Exercise Recap: 3DSpace FP

1. In this exercise, you have:

 Installed the FP for 3DSpaceIndex


 Performed the post FP configuration
 Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

507
CSV Apps

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
3DSpace – FP Applications

You have just finished the FP installation for 3DSpace. It is now time to perform FP installation for CSV Apps apps you installed during the GA
install.

The fix packs should be installed in the same order that you installed the GA applications.
Proceed now with the FP installation of the applications
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

CSV Apps Solution:


00. 3DExplore
01. ENOVIAIPClassificationFoundation
02. ENOVIACollaborativeTasksFoundation
03. ENOVIAX-CADDesignFoundation *
04. ENOVIACollaborationforMicrosoftServer *
05. ConnectorforCATIAV5Server *
06. ENOVIAEnterpriseChangeManagement
07. ENOVIAProjectManagementFoundation
08. ENOVIAEngineeringBOMManagementFoundation
09. UnifiedX-CADDesign Management *
10. ENOVIADocumentManagement
* If you do not have client machine in this training, there is no need of installing the media
If you skipped the "3DSpace add-ons" you must skip this section and go directly to the next section "3DSpace – WAR build".

509
3DSpace – FP Applications

You have almost completed the 3DSpace installation, only the FP for the Add-ons are missing:
GA 3DSpace installation (done)
GA Application installation (done)
FP 3DSpace installation (done)
FP Application installation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

At this time, go to the "CSV Apps Solution" document and continue with the FP installation of the applications.

510
CSV Apps : FP Installers

You should have finished installing the 3DSpace FP, you can now complete the FP of the CSV Apps applications:

Installers will be compressed and are available in the following PATH:


<Media>\ Part_3DEXP_OpenApps.AllOS \<The Installer>
<Media>\Part_3DEXP_platform.Windows64\<The Installer>
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Media>\Part_3DEXP_WebApps.Windows64\<The Installer>

You will need to copy the file to "Your Installer PATH" folder and extract it.
<Installers>\Media_R2023x_FP2306\<The Installer>
You must un-compress the installers then delete the compressed file you copied (saves disk space)

You will find the usual executables "<Installers>\<Extracted Code>\1":


oGUI: setup.exe
oTUI: StartTUI.exe

For each installer, the media location will be provided:


"<DVD Media>.Windows64"  The DVD name
<The Installer>  The name

511
Exercise: CSV Apps

1. Introduction
2. 3DSpace “Collaborative Industry Innovator” Apps FP
00. Install FP for 3DExplore
01. Install FP for ENOVIAIPClassificationFoundation
02. Install FP for ENOVIACollaborativeTasksFoundation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

03. Install FP for ENOVIAX-CADDesignFoundation *


04. Install FP for ENOVIACollaborationforMicrosoftServer *
05. Install FP for ConnectorforCATIAV5Server *
06. Install FP for ENOVIAEnterpriseChangeManagement
07. Install FP for ENOVIAProjectManagementFoundation
08. Install FP for ENOVIAEngineeringBOMManagementFoundation
09. Install FP for UnifiedX-CADDesign Management * .
10. Install FP for ENOVIADocumentManagement

* If you do not have client machine in this training, there is no need of installing the media

30 minutes

512
CSV Apps : Configuration and Key Parameters

Now that 3DSpace has been Fix Packed it is time to continue with the Apps. The Hotfixes will use configuration options that you should be familiar with
by now:

Configuration Updated:
Database objects : Updated
TomEE+ needed : Updated
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Installing Applications FPs will done using a silent installation script.

For the Silent installation, the “User_Intentions” files generated during the GA Installation of the CSV_Apps are used.

513
Disable FTS_Indexing Task

1. Before starting with the CSV Apps installation, disable the task for “FTS_Indexing if the status shows Ready”
a. Launch Task Scheduler
b. Task Scheduler Library  FTS_Indexing_Task  Disable
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

514
CSV Apps : FP Service Installer

1. Launch an Administrator command prompt.

2. Execute the script for the silent installation as follows:

E:\Media\CSV_Apps\FP2306_Install.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

515
Snapshot : FP2306_Install.bat

The content of the “FP2306_Install.bat” file is as shown below:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

516
CSV Apps : Technical Validation

00. 3DExplore
Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\3DExplore\InstallData\log
II. <Time Stamp>-0000_CODE_win_b64_ENOVIA_RIPE.media
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

01. ENOVIA IP Classification Foundation


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\LibraryCentral\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_LBC.media

02. ENOVIA Collaborative Tasks Foundation


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\CollaborativeTasks\V6R2023x\InstallData\
II. log\<TimeStamp>-0000_CODE_win_b64_ENOVIA_TASK.media

03. ENOVIA X-CAD Design Foundation


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\DesignerCentral\V6R2023x\InstallData\log\
II. <timestamp>-0000_CODE_win_b64_ENOVIA_DCF.media

517
CSV Apps : Technical Validation

04. ENOVIA Collaboration for Microsoft Server


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\Integrations\MSF\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_MFS.media
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

05. Connector for CATIAV5 Server


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\ConnectorforCATIAV5\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_CT5.media

06. ENOVIA Enterprise Change Management


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EnterpriseChangeMgt\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_ECM.media

07. ENOVIA Project Management Foundation


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\ProgramCentral\V6R2023x\InstallData\log\<TimeStamp>-
0000_CODE_win_b64_ENOVIA_PRF.media

518
CSV Apps : Technical Validation

08. ENOVIA Engineering BOM Management Foundation


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\EngineeringCentral\V6R2023x\InstallData\log\
II. <Timestamp>2-0000_CODE_win_b64_ENOVIA_ENG.media
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

09. ENOVIA Unified X-CAD Design Management


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\UnifiedX-CADDesign\V6R2023x\InstallData\
II. log\<timestamp>0000_CODE_win_b64_ENOVIA_UCAD.media

10. ENOVIA Document Management


Check the "Error.log" & "*Stderr.txt" in folder:
I. D:\3DEXPERIENCE\R2023x\3DSpace\Apps\DocumentManagement\V6R2023x\InstallData\log\
II. <timestamp>-0000_CODE_win_b64_ENOVIA_DOCM.media

519
CSV Apps : Enovia Document Management

Always search the “Program Directories” for “Summary of Changes” and explore the role and product for new installations, that where not available
in GA:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

520
Exercise Recap: CSV Apps

1. In this exercise, you have:

 Installed FP for 3DExplore


 Installed FP for ENOVIAIPClassificationFoundation
 Installed FP for ENOVIACollaborativeTasksFoundation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Installed FP for ENOVIAX-CADDesignFoundation


 Installed FP for ENOVIACollaborationforMicrosoftServer
 Installed FP for ConnectorforCATIAV5Server
 Installed FP for ENOVIAEnterpriseChangeManagement
 Installed FP for ENOVIAProjectManagementFoundation
 Installed FP for ENOVIAEngineeringBOMManagementFoundation
 Installed FP for UnifiedX-CADDesign Management
 Installed FP for ENOVIADocumentManagement

521
3DSpace – FP Applications

Following sections have been completed for 3DSpace installation:

GA 3DSpace installation (done)


GA Application installation (done)
FP 3DSpace installation (done)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

FP Application installation (done)

Next steps:
Post 3DSpace Installation.

522
Exercise: 3DSpace Post Install and War generation

In this exercise, you will:

a. Compilation of Programs using MQL


b. Building CAS and NO-CAS war files
c. Update of enovia.ini file
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Deployment of Application server


e. Validation of 3DSpace service and 3DSpace Internal service

30 minutes

523
3DSpace – Post Actions

1. Edit the setenv.bat in the TomEE+ 3DSpace(CAS)


D:\3DEXPERIENCE\TomEE\TomEE3DSpace\bin\setenv.bat

2. validate the last line with:


CALL D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\templates\setenvCAS.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3. Save the file.

4. Open MQL using the desktop shortcut and execute the following commands:
set context user creator; NOTE : To save time, you can
execute compile prog *
compile prog * force; force size 250;
quit;

There should be no compile errors. This command may take a while depending on the characteristics of the machine (~15 to 20minutes).

524
3DSpace - WAR Build

The "WAR" build process is the act of merging the 3DSpace GA+FP code and any creating a J2EE applications.

a. The applications are normally installed under the folder:


D:\3DEXPERIENCE\R2023x\3DSpace\Apps
b. They also have code integrated to the stack under the folder:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

D:\3DEXPERIENCE\R2023x\3DSpace\STAGING
c. The "WAR" will be created under:
D:\3DEXPERIENCE\R2023x\3DSpace\distrib

The WAR builder batch file are BuildDeploy3DSpace_NoCAS.bat and BuildDeploy3DSpace_CAS.bat under
D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\code\command

The STAGING folder is where the 3DSpace service will build the WAR file from. It will then copy the war file to the distrib folder which can then be
deployed to the 3DSpace TomEE+ instance. This process is why you need to rebuild the "WAR" file after installing any new application into 3DSpace.

525
3DSpace - WAR Build

Time to rebuild the web application to be deployed in:


a. 3DSpace TomEE+ code PATH : D:\3DEXPERIENCE\TomEE\TomEE3DSpace\webapps
b. 3DSpace Internal TomEE+ code PATH : D:\3DEXPERIENCE\TomEE\TomEE3DSpaceInternal\webapps

c. Make sure that both TomEE+ are stopped


d. Use the two shortcuts on your desktop, launch them one after the other:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DSpace does not automatically copy the WAR file to the application server, find the two folders containing the WAR files for TomEE3DSpace and
TomEE3DSpaceInternal

a. Clear the content of the “TomEE3DSpace\webapps” and “TomEE3DSpaceInternal\webapps” folders


b. Copy only the .war file from the distrib folder to the webapps folder to each TomEE+:
c. TomEE3DSpace : D:\3DEXPERIENCE\R2023x\3DSpace\distrib_CAS
d. TomEE3DSpaceInternal : D:\3DEXPERIENCE\R2023x\3DSpace\distrib_NoCAS

In the distrib folder the other files and folders are not needed and should not be copied, to save space you can delete them.

526
3DSpace – Post Installation Validation

1. Open the enovia.ini file at D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\code\bin. Increase the MX_JAVA_OPTIONS and


MX_MEMORY_SYSTEM_LIMIT values.

MX_JAVA_OPTIONS=-Xmx4096m
MX_MEMORY_SYSTEM_LIMIT=8192m
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Start and stop both TomEE+


<TomEE 3DSpace>\bin\startup.bat
<TomEE 3DSpace Internal>\bin\startup.bat
Wait for it to finish deploying the application.

<TomEE 3DSpace>\bin\shutdown.bat
<TomEE 3DSpace Internal>\bin\shutdown.bat
Wait for it to finish properly closing the application.

3. Check for errors and clean the log folder afterward


<TomEE 3DSpace>\logs\*.log
<TomEE3DSpace Internal>\logs\*.log

527
3DSpace: Validation

1. In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. Redirect to 3DSpace TomEE+ after 3DPassport Authentication

2. Restart the "Apache2.4" Service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

3. Start TomEE+ if not started


a. <TomEE 3DPassport>\bin\startup.bat
b. <TomEE 3DSpace>\bin\startup.bat
c. <TomEE 3DSpace Internal>\bin\startup.bat
Wait for each to finish deploying the application.

MyURLs.html
4. Access the MyURLs.html or :
https://3dspace.mytraining.com:443/3dspace
https://internal.mytraining.com:443/internal

Each time you test a new URL


bookmark it in Firefox.

528
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DSpace

3DSpaceInternal
3DSpace: Validation

529
3DSpace: Uninstallation

Windows normal uninstall procedure:

a. Stop TomEE+ if it is running <Service Name>

b. In "Programs and Features" uninstall:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

a. There is also a Uninstall.bat file in the In "Programs and Features" uninstall:


"Dassault Systemes <Service Name> 3DEXPERIENCE R2023x"

b. In the Database instance, drop the user, tablespace / database.

c. Remove the folders:


D:\3DEXPERIENCE\R2023x\<Service Name>
D:\3DEXPERIENCE\TomEE\TomEE<Service Name>

530
Exercise Recap: 3DSpace FP

1. In this exercise, you have:

 Completed Compilation of Programs using MQL


 Build CAS and NO-CAS war files
 Updated the enovia.ini file
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Completed the deployment of Application server


 Validation of 3DSpace service and 3DSpace Internal service is successful

531
3DNotification

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
Exercise: 3DNotification

In this exercise, you will:

a. Install the 3DNotification FP Service


b. Perform the post install configuration
c. Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Functional Validation the FP service

15 minutes

533
3DNotification: FP Service Installer

There is no "Global 3DEXPERIENCE platform Installer" for FP you must update each service individually.

a. Ensure that 3DNotification service is stopped

If you do not stop the 3DNotification service, the installer will automatically stop the node service first and then proceed with installation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

However, if you execute into security or permission issue the service may not be stopped.

b. Use the normal "Service Installer":


<Media>\ Part_3DEXP_Platform.Windows64\1\Software \
You will find:
3DNotification-V6R2023x.HF1.Windows64.zip

c. Unzip the proper OS version to <Your Installer PATH>


<Installers>\3DNotification.Windows64\1

d. Navigate to this path and find:


GUI: setup.exe
TUI: StartTUI.exe

534
3DNotification: FP Media Installer – Oracle Summary

It is strongly recommended that you copy the installation information into a text file prior to clicking the "install" button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable, can easily by


copied into report.

535
3DNotification: FP Media Installer – SQL Server Summary

1. It is strongly recommended that you copy the installation information into a text file prior to clicking the "install" button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable, can easily by


copied into report.

536
3DNotification: FP Post Installation

a. Start and stop the 3DNotification service from service panel

b. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\3DNotification\win_b64\templates\3DNotification_httpd_fragment.conf
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Update the values for "port" and "FQDN" in the fragment file.
http://3dnotification.mytraining.com:8680

d. Backup the fragment file to:


D:\3DEXPERIENCE\conf\Fragment\3DNotification_httpd_fragment.conf.FP

537
3DNotification: FP Technical Validation

"FP technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.
There are 2 steps related to the installer log, database and expected file deployment

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DNotification


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Installer error log should be empty in:


<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_INTF_SC.media\Errors.log & *Stderr.txt

Size should be 0 bytes


You should see 2 "…media…" folders, one was for GA, the new one is the FP.

If you had to modify values in the installer dialogues you will see these errors in the Errors.log you will need to validate if any of these messages
require corrective action.

538
3DNotification: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. 3DNotification NodeJS

1. Restart the Apache service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

2. Start 3DNotification Node


Start the 3DNotification service Each time you test a new
URL bookmark it in Firefox.
Access the URL:
https://3dnotification.mytraining.com:443/3dnotification/
MyURLs.html
3DNotification will be redirected by Apache to a "3DNotification Service" page.

539
Exercise Recap: 3DNotification

1. In this exercise, you have:

 Installed the FP for 3DNotification


 Performed the post FP configuration
 Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Functional Validation the FP service

540
3DComment

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
Exercise: 3DComment

In this exercise, you will:

a. Install the 3DComment FP Service


b. Perform the post install configuration
c. Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Functional Validation the FP service

15 minutes

542
3DComment: FP Service Installer

There is no "Global 3DEXPERIENCE platform Installer" for FP you must each service individually.

a. Ensure that "TomEE3DComment" is stopped


D:\3DEXPERIENCE\TomEE\TomEE3DComment\bin\shutdown.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

If you do not stop TomEE+, the installer will not be able to replace certain files automatically, this can result in errors in the log or unexpected
behavior.

b. Use the normal "Service Installer":


<Media>\Part_3DEXP_Platform.Windows64\1\Software\
You will find:
3DComment-V6R2023x.HF1.Windows64.zip

c. Unzip the proper OS version to <Your Installer PATH>


<Installers>\ 3DComment.Windows64\1

d. Navigate to this path and find:


GUI: setup.exe
TUI: StartTUI.exe

543
3DComment: FP Service Installer – Oracle Summary

As with GA, it is recommended that you log the Installation Overview window containing your input values.
a. If you choose to take a screen shot, the window can be resized so you can see all the values clearly.
b. Proceed with the update using the same key values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable, can easily by


copied into report.

544
3DComment: FP Service Installer – SQL Server Summary

As with GA, it is recommended that you log the Installation Overview window containing your input values.
a. If you choose to take a screen shot, the window can be resized so you can see all the values clearly.
b. Proceed with the update using the same key values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable, can easily by


copied into report.

545
3DComment: FP Post Installation

3DComment creates the database objects immediately during the installation phase.

a. TomEE+ code PATH: D:\3DEXPERIENCE\TomEE\TomEE3DComment

b. Start and stop TomEE+ (or use you Desktop icon)


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<TomEE 3DComment>\bin\startup.bat
Wait for it to finish deploying the application.

c. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\3DComment\win_b64\templates\3DComment_httpd_fragment.conf
Update the values for "port" and "FQDN" in the fragment file.
http://3dcomment.mytraining.com:8580

d. Backup the fragment file to:


D:\3DEXPERIENCE\conf\Fragment\3DComment_httpd_fragment.conf.FP

546
3DComment: FP Technical Validation

"FP technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DComment

1. Installer error log should be 0 bytes and can be found at:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_CMNT.media\Errors.log & *Stderr.txt

Size should be 0 bytes


You should see 2 "…media…" folders, one for GA and a new one for the FP.

If you had to modify values in the installer dialogues you will see these errors in Errors.log you will need to validate if any of these messages require
corrective action.

2. Expected file creation or updates:


<TomEE 3DComment>\webapps\3dcomment.war
<TomEE 3DComment>\bin\setenv.bat

547
3DComment: Validation

1. In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. 3DComment TomEE

2. Restart the "Apache2.4" Service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

3. Start TomEE
a. <TomEE 3DComment>\bin\startup.bat
Wait for it to finish deploying the application. Each time you test a new URL
bookmark it in Firefox.
Access the MyURLs.html or
https://3dcomment.mytraining.com:443/3dcomment/monitoring/healthcheck

3DComment will respond with the following page.


MyURLs.html

548
Exercise Recap: 3DComment

1. In this exercise, you have:

 Installed the FP for 3DComment


 Performed the post FP configuration
 Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Functional Validation the FP service

549
3DSwym

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
3DSwym: FP Installation

Installation of 3DSwym comprises of below elements.

Installing EXALEAD CloudView FP

3DSWYM FP
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Installing 3DSwym Foundation


Installing 3DSwym Video Converter
Installing 3DSwym Index

551
Exercise: 3DSwym

In this exercise, you will:

a. Install the Exalead CloudView FP Service


b. Install the 3DSwym FP Service
c. Perform the post install configuration
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Technical Validation of FP Service


e. Functional Validation the FP service

15 minutes

552
EXALEAD CloudView : FP Service Installer

1. Use the normal "Service Installer":


<Media>\\Part_3DEXP_Platform.Windows64\3\Software

You will find:


EXALEAD_CloudView-V6R2023x.HF1.Windows64.zip
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Unzip the proper OS version to <Your Installer PATH>


<Installers>\ \EXALEAD_CloudView.Windows64\1
3. Navigate to this path and find:
GUI: setup.exe
TUI: StartTUI.exe

553
EXALEAD CloudView : FP Service Installer

1. As with GA, it is recommended that you log the Installation Overview window containing your input values.
a. If you choose to take a screen shot, the window can be resized so you can see all the values clearly.
b. Proceed with the update using the same key values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

554
3DSwym : FP Service Installer

There is no "Global 3DEXPERIENCE platform Installer" for FP you must each service individually.

a. Ensure that "TomEE+3DSwym" is stopped


D:\3DEXPERIENCE\TomEE\TomEE3DSwym\bin\shutdown.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

If you do not stop TomEE+, the installer will not be able to replace certain files automatically, this can result in errors in the log or unexpected behavior.

b. Use the normal "Service Installer":


<Media>\Part_3DEXP_platform.Windows64\1\Software\
You will find:
3DSwym-V6R2023x.HF1.Windows64.zip

c. Unzip the proper OS version to <Your Installer PATH>


<Installers>\3DSwym.Windows64\1

d. Navigate to this path and find:


GUI: setup.exe
TUI: StartTUI.exe

555
3DSwym: FP Service Installer – Oracle Summary

1. As with GA, it is recommended that you log the Installation Overview window containing your input values.
a. If you choose to take a screen shot, the window can be resized so you can see all the values clearly.
b. Proceed with the update using the same key values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

556
3DSwym: FP Service Installer – SQL Summary

1. As with GA, it is recommended that you log the Installation Overview window containing your input values.
a. If you choose to take a screen shot, the window can be resized so you can see all the values clearly.
b. Proceed with the update using the same key values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable,
The textcan easily by can
is selectable,
copied intobyreport.
easily copied into report.

557
3DSwym : FP Post Installation

1. 3DSwym creates the database objects immediately during the installation phase.

a. TomEE+ code PATH: D:\3DEXPERIENCE\TomEE\TomEE3DSwym

b. Start and stop TomEE+ (or use you Desktop icon)


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<TomEE3DSwym>\bin\startup.bat
Wait for it to finish deploying the application.

c. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\3DSwym\win_b64\templates\3DSwym_httpd_fragment.conf
Update the values for "port" and "FQDN" in the fragment file.
http://3dswym.mytraining.com:8780

d. Backup the fragment file to:


D:\3DEXPERIENCE\conf\Fragment\3DSwym_httpd_fragment.conf.FP

558
3DSwym : FP Technical Validation

"FP technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\3DSwym

1. Installer error log should be 0 bytes and can be found at:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_X3D_SWYM.media\Errors.log & *Stderr.txt


Size should be 0 bytes
You should see 2 "…media…" folders, one for GA and a new one for the FP.

If you had to modify values in the installer dialogues you will see these errors in Errors.log you will need to validate if any of these messages require
corrective action.

2. Expected file creation or updates:


a. <TomEE3DSwym>\webapps\3dsearch.war
b. <TomEE3DSwym>\webapps\3DSwym.war
c. <TomEE3DSwym>\webapps\uwp.war

559
EXALEAD CloudView : Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. Check the Service Status

1. Restart the "Apache2.4" Service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

2. Restart the Service if not automatically started.

560
3DSwym: Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Redirect to 3dswym TomEE+ after 3DPassport Authentication

1. Start TomEE+ (3DSwym + 3Dpassport)


a. < 3Dpassport>\bin\startup.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. <TomEE3DSwym>\bin\startup.bat Each time you test a new URL


bookmark it in Firefox.
Wait for it to finish deploying the application.
Access the MyURLs.html or https://3dswym.mytraining.com/3dswym

MyURLs.html

561
Exercise Recap: 3DSwym

1. In this exercise, you have:

 Installed the FP for Exalead CloudView


 Installed the FP for 3DSwym
 Performed the post FP configuration
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Technical Validation of FP Service


 Functional Validation the FP service

562
FCS Central

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
Exercise: FCS Central

In this exercise, you will:

a. Install the FCS Central FP Service


b. Perform the post install configuration
c. Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Functional Validation the FP service

15 minutes

564
FCS Central: FP Service Installer

There is no "Global 3DEXPERIENCE platform Installer" for FP you must each service individually.

a. Ensure that "TomEEFCSCentral" is stopped


D:\3DEXPERIENCE\TomEE\TomEEFCSCentral\bin\shutdown.bat
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

If you do not stop TomEE+, the installer will not be able to replace certain files automatically, this can result in errors in the log or unexpected
behavior.

b. Use the normal "Service Installer":


<Media>\Part_3DEXP_Platform.Windows64\3\Software\
You will find:
FileCollaborationServer-V6R2023x.HF1.Windows64.zip

c. Unzip the proper OS version to <Your Installer PATH>


<Installers>\FileCollaborationServer.Windows64\1

d. Navigate to this path and find:


GUI: setup.exe
TUI: StartTUI.exe

565
FCS Central: FP Service Installer

1. As with GA, it is recommended that you log the Installation Overview window containing your input values.
a. If you choose to take a screen shot, the window can be resized so you can see all the values clearly.
b. Proceed with the update using the same key values.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

566
FCS Central: FP Post Installation

FCS installer does not require much, simply some preparation.

a. Start and stop TomEE+ (or use the Desktop icon)


<TomEEFCSCentralPath>\bin\startup.bat
Wait for it to finish deploying the application.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<TomEEFCSCentralPath>\bin\shutdown.bat
Wait for it to finish closing properly the terminal.

567
FCS Central : Technical Validation

"FP technical validation" refers to validation of the installation process, i.e. did it install without errors and did it complete what it was supposed to do.

Defining the service code installation path: D:\3DEXPERIENCE\R2023x\FCSCentral

1. Installer error log should be 0 bytes and can be found at:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_ENOVIA_FCS.media\Errors.log & *Stderr.txt

Size should be 0 bytes


You should see 2 "…media…" folders, one for GA and a new one for the FP.

If you had to modify values in the installer dialogues you will see these errors in Errors.log you will need to validate if any of these messages require
corrective action.

2. Expected file creation or updates:


<TomEEFCSCentral>\webapps\fcs.war
<TomEEFCSCentral>\bin\setenv.bat

568
FCS Central : Technical Validation

3. Edit the fragment file :


D:\3DEXPERIENCE\R2023x\FCSCentral\win_b64\templates\fcs_httpd_fragment.conf
Update the values of the "port" and "FQDN" in the fragment file.
http://fcscentral.mytraining.com:8880/fcs
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Make sure that the CORS (Cross-Origin Resource Sharing) is activated for the FCS.

Observe that the contents of the CORS header declaration are also in the fragment file.

569
FCS Central : Validation

In this section you will validate the service functionality and part of the infrastructure deployment
a. Apache
b. FCS Central TomEE+

1. Restart the "Apache2.4" Service


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. Open service manager

2. Start TomEE+
a. <TomEEFCSCentral>\bin\startup.bat Each time you test a new URL
Wait for it to finish deploying the application… bookmark it in Firefox.
Access the MyURLs.html or https://fcscentral.mytraining.com:443/fcs/servlet/fcs/about
MyURLs.html

570
FCS Central: Post Installation Configuration MQL fcs url

Users are linked to a "Site", Sites are linked to "Locations" and the Locations are directly linked to the FCS.
During the training you create one FCS, to be used by the STORE definitions. If a user does not have a "Site" defined the files will be checked into the
default "STORE" definition i.e. “central” (controlled by the policy object).

User Site
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Default if User has no Site

Store Note: FCS central is not a new site, it location


refers to the fcs url used in the STORE
definition instead of the classic
3DSPACE internal.
FCS Path FCS Path
Central Remote

For now the objective is to use the proper FCS URL and prepare the path structure for
the FCS location definition.
You can perform this in the 3DDashboard using the Enterprise control center tool.

“FCS Remote” subject will be treated in the “3DEXPERIENCE platform Administration”


training.

571
FCS Central: Post Installation Configuration MQL fcs url

It is a good practice to configure the STORE with a different URL and path and not use the default. What is the “FCS Central”, it is not a new
site/location, is fundamentally the fcs url re-defined in the stores.
o New FCS URL
o New location for the files
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. Open an command prompt and run below command for creation of folder for FCS file storage

mkdir D:\3DEXPERIENCE\data\FCS\Central

1. Open an MQL command window:

set context user creator;


modify store STORE path D:\3DEXPERIENCE\data\FCS\Central\STORE fcs 'https://fcscentral.mytraining.com/fcs' ;
modify store 'Image Store' path D:\3DEXPERIENCE\data\FCS\Central\ImageStore fcs 'https://fcscentral.mytraining.com/fcs' ;
modify store plmx path D:\3DEXPERIENCE\data\FCS\Central\plmx fcs 'https://fcscentral.mytraining.com/fcs' ;

572
Exercise Recap: FCS Central

1. In this exercise, you have:

 Installed the FP for FCS Central


 Performed the post FP configuration
 Technical Validation of FP Service
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Functional Validation the FP service


 Post Installation configuration MQL fcs url

573
3DIndex Server

Topics to be covered:

1. 3DPassport
2. 3DDashboard
3. 3DSearch
4. 3DSpaceIndex
5. 3DSpace
6. CSV Apps
7. 3DNotification
8. 3DComment
9. 3DSwym
10. FCS Central
11. 3DIndex Server
Exercise: 3DIndex Server

In this exercise, you will:

a. Install the 3DIndex Server FP Service


b. Technical Validation of FP Service
c. Administration the 3DIndex Server
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Post Installation of 3DIndex Server

15 minutes

575
3D Indexing Server: FP Service Installer

There is no "Global 3DEXPERIENCE platform Installer" for FP’s.


1. Use the normal "Service Installer" based on your OS selection:
<Media>\Part_3DEXP_Platform.Windows64\1\Software\
You will find:
3DIndexingServer-V6R2023x.HF1.Windows64.zip
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Unzip the file to <Your Installer PATH>


<Installers>\3DIndexingServer.Windows64\1
GUI: setup.exe
TUI: StartTUI.exe

576
3D Indexing Server: FP Service Installer

1. It is strongly recommend that you copy the installation information into a text file prior to clicking the install button.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is selectable, can easily by


copied into report.

577
3D Indexing Server: FP Technical Validation

"FP technical validation" refers to validation of the installation process, that is, did it install without errors and did it complete what it was supposed to do.

Target installation PATH: D:\3DEXPERIENCE\R2023x\VolumeSearch

1. Installer error log should be 0 bytes and can be found at:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\<Latest timestamp>-0000_CODE_win_b64_ENOVIA_PIX.media\
Errors.log
Size should be 0 bytes

2. In Windows Services manager, verify that the new service running.

If you had to modify values in the installer dialogues you will see these errors in
Errors.log you will need to validate if any of these messages require corrective
action.

578
3D Indexing Server: Administration

1. If you change the default password (recommended) be sure that the user 3DIndexAdminUser has a secure password:

a. Open the MQL command using the shortcut on your desktop.


b. Execute the following commands:
This is an optional step.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

set context user creator; We have already set


mod person 3DIndexAdminUser pass Zaq1@WsxCde3 ; this password during
quit; 3DIndexing Server GA
installation

or

Use https://internal.mytraining.com/internal and change the password.

579
3D Indexing Server: Post Installation

Ensure that the 3D Indexing server has an access to the DSLS


Go to 3DSpace bin folder: D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\code\bin
Open a command prompt to that folder and execute the following command:
DSCheckLS.exe
You should see the following:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

580
3D Indexing Server: Post Installation

To be usable, the 3D Indexing Server requires a few post installation steps:


1. First step is to check the Environment and 3DSpace access, using the desktop shortcut 3Dindex
Environment Administration edit the default Alias. Ensure that all the information displayed is correct.
a. Validate the 3DIndex connection with 3DSpace Internal by clicking the drop down to display the list of
security contexts available for this user.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

TomEE3DSpaceInternal should
be running.
Do not change the
User: 3DIndexAdminuser

b. Click OK. If there are any connection issues they will be reported.

581
3D Indexing Server: Post Installation

Time to execute the first baseline indexation using the desktop shortcut "Data re-indexation batch".
Finally check the result of the indexation, via the desktop shortcut "IndexationReport.html“ or access the file from the path ,
“D:\3DEXPERIENCE\data\3DIndexes\BBDMonitor\Reporting.html”
Check all the tabs.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

NOTE - Report can be seen from the IE only as some plugins are blocked

If you had to modify values in the installer dialogues you will see these
errors in the Errors.log you will need to validate if any of these
messages require corrective action.
The "Data re-indexation batch" window will close immediately, but the
indexation job is still running in the background.

582
3D Indexing Server: Post Installation

Resetting the indexation in case of error:

a. If there are problems related to indexing, try forcing re-indexation of all data as follows:
a. Rename the 3DIndex data folder located here:
b. D:\3DEXPERIENCE\data\3DIndexes (rename it to e.g. 3DIndexes_old)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. execute the indexing task again (from the shortcut on the desktop)
d. The folder "3DIndexes" should be recreated and new index data generated

b. 3DIndex – Scheduled task


a. To automatically index new data, add a "Scheduled Task" in Windows Task Scheduler
b. The task should execute the same command as the shortcut "Data re-indexation batch"

583
3D Indexing Server: Post Installation

1. 3D Indexer server does not automatically configure a scheduled task to execute at regular
intervals. You will have to set this up manually:
2. Open Computer Management, navigate to the Task Scheduler Library and export the
"FTS_indexing_task" to folder D:\3DEXPERIENCE\conf\

3. Rename the file : 3DX_Indexing_task.xml


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Create an empty batch file


D:\3DEXPERIENCE\conf\3DX_Indexing_task.bat

5. Add the lines to 3DX_Indexing_task.bat:

6.CATSTART -run "BBDAdminPlayer -EnvName 3DIndex_DefaultEnv


7.[-retry]" –env -direnv -ThumbnailOnly
“D:\3DEXPERIENCE\R2023x\VolumeSearch\CATEnv"

5. Edit the file 3DX_Indexing_task.xml Update the entries of <Command> with


1. D:\3DEXPERIENCE\conf\3DX_Indexing_task.bat

584
3D Indexing Server: Post Installation

6. Navigate to the Computer Management, task Schedule Library and choose import Task
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

7. choose the file: D:\3DEXPERIENCE\conf\3DX_Indexing_task.xml

If the two tasks are running on the same


machine, change the time so that the
"3DX_Indexing_task" starts at the end of
the "FTS_Indexing_Task".

585
3D Indexing Server: Post Installation

8. Check the values on each tab if you want to change some settings and choose Ok.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

586
3D Indexing Server: Uninstallation

Windows normal uninstall procedure:


a. Stop the service
b. Check if 3DEXPERIENCE R2023x Volume (D: drive) Shadow Copy is disabled

c. In "Programs and Features" uninstall:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

" Dassault Systemes 3D index Server 3DEXPERIENCE R2023x"


or
The Uninstall.bat file in the D:\3DEXPERIENCE\R2023x\<Service Name>

587
Exercise Recap: 3DIndex Server

1. In this exercise, you have:

 Installed the FP for 3DIndex Server


 Technical Validation of FP Service
 Completed Administration the 3DIndex Server
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Post Installation of 3DIndex Server

588
Summary

Hot Fix Installation of all Services

In this lesson, you have installed the FP for components:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 3DPassport
 3DDashboard
 3DSearch
 3DSpaceIndex
 3DSpace
 CSV Apps
 3DNotification
 3DComment
 3DSwym
 FCS Central
 3DIndex Server

589
Lesson 7: 3DEXPERIENCE Native Apps & Client Integration

In this lesson, you will perform post operations and install Native Clients.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3 hours

590
Post Operations

Topics to be covered:

1. Post Operations
2. Native Client
3. Client Integration
End of Installation Post Operations

1. Since this is your "admin" desktop it is recommended that you order your shortcuts
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

When you create shortcuts in your


"Favorites bar" it can become messy.
Here is an example of how you may
wish to organize your shortcuts.

10 minutes

592
End of Installation Post Operations

1. When you running the TomEE+ Startup scripts the trace windows are often small and will lack buffer to show enough history. Once the windows
pops-up, it is recommended to change its layout properties as follow:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

You can even set a fixed position that will be used each time the window pops-up, great for multi-monitor setup.

593
End of Installation Post Operation

1. A useful tip for accessing logs and cleaning them from time to time is to create a Desktop Folder containing shortcuts for the log folders from the
application and TomEE+

2. Some key log files are:


a. <Apache ServerRoot>\logs
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Access.log, error.log, httpd.pid, and for each service : *.cus, *.err & *.log

b. <TomEE+ Service>\logs
Catalina*.log, localhost*.log

c. <Application Service>\log
i. For 3DSpace you will find: ematrixwar.log, mxAudit.log, mxtrace.log and 3DXServer*.log

Not all applications will have a logs folder.

594
Native Client

Topics to be covered:

1. Post operations
2. Native Client
3. Client Integration
Native Apps Installation and Configuration

1. Introduction
2. Client – Prerequisites
3. 3DEXPERIENCE Native Overview
4. Desktop Components: Constraints and Limits
5. Importing the CA into the Client machine
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

6. 3DEXPERIENCE Native – Key Parameters


7. 3DEXPERIENCE Native – GA Installation
8. 3DEXPERIENCE Native – Technical Validation
9. 3DEXPERIENCE Native – FP Installation
10. 3DEXPERIENCE Native – Post Configuration
11. 3DEXPERIENCE Native – Uninstallation

180 minutes

596
Introduction

In order to execute the integration connectors you will need some "client prerequisites" for the software connecting to the p latform. This training is
not a "client" install training, you will not be diving into the details of client installation. If you need help the trainer will assist you with these steps.

3DEXPERIENCE Native Client


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This first step, as always, is to refer to the 3DS website, www.3ds.com, and check if your machine meets the requirement for the Native clients.

Go to the Program directory URL:


https://www.3ds.com/support/documentation/program-directories/

In the right pane you will find "Native OS Clients", see supporting images in the next slide.

597
Client – Prerequisites

First check that your laptop Hardware is compatible:


You will perform some simple checks to ensure compatibility. For Certified Hardware compliancy details refer to:
o https://www.3ds.com/support/certified-hardware/
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

598
Client – Prerequisites

Connect with your account, select your version and find " Native OS Clients"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

599
Client – Prerequisites

Here are some typical requirements extracted from the 3DS Program Directory.
Resources:
30 GB of free disk space on your fasted drive
8-12GB of RAM
4 CPU
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Operating System
Windows 10 (for versions consult the pdf file indicated below)
https://media.3ds.com/support/certfied_sotfware/Windows10/Windows-10-support-DS-products.pdf

Java
IBM Semeru Runtime Open Edition for Java 17.0.3 is a Validated Platform
Oracle JDK 17.0.x,with x>=3, is a Compatible Platform.
https://media.3ds.com/support/progdir/623x_u01/prerequisites/strategicplatforms_for_native_os_client.html

600
3DEXPERIENCE Native Apps Overview

CATIA delivers the unique ability not only to model any product, but to do so in the context of its real-life behavior: design in the age of experience.
Systems architects, engineers, designers and all contributors can define, imagine and shape the connected world.

CATIA, powered by Dassault Systemes’ 3DEXPERIENCE platform, delivers:


A Social design environment built on a single source of truth and accessed through powerful 3D dashboards that drive business intelligence,
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

real-time concurrent design and collaboration across all stakeholders including mobile workers.
An Instinctive 3DEXPERIENCE, for both experienced and occasional users with world-class 3D modeling and simulation capabilities that
optimize the effectiveness of every user.
An Inclusive product development platform that is easily integrated with existing processes & tools. This enables multiple di sciplines to
leverage powerful and integrated specialist applications across all phases of the product development process.

CATIA’s Design, Engineering and Systems Engineering applications are the heart of Industry Solution Experiences from Dassault Systèmes to
address specific industry needs. This revolutionizes the way organizations conceive, develop and realize new products, delivering competitive edge
through innovative customer experiences.

601
Desktop Components: Constraints and Limits

3DEXPERIENCE Launcher (alias DSLauncher)

3DEXPERIENCE Launcher is a mandatory component for the Single Sign On mechanism and is installed automatically during the Native App
installation.
Run as a Windows Service and manages the SSO integration between Web browser and 3DEXPERIENCE native client by using
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DPassport cookie(s).

Previously only supported HTTP 200 OK code. In R2023x additional HTTP error codes are supported to allow X509 Client certificate based
authentication.

To execute correctly, it needs to be able to send and receive requests to 3DEXPERIENCE platform services from the same desktop host: an
incorrect network proxy configuration can interfere with this communication.

The deployment requirements for the desktop are the same as R2023x:
Customer network administrator must update the Windows OS host file to resolve the "dslauncher.3ds.com" address locally (loo pback
addresses (127.0.0.1 / ::1 )
If you have a forward proxy, authorize local communication by adding an exception for the address "dslauncher.3ds.com" (bypass proxy
server for local address).
Make sure the local firewall or antivirus doesn't block the local port numbers.
The 3DEXPERIENCE Launcher default ports are: 20300, 33200, 40600. If these ports are already in use during installation 3 new ports are
randomly chosen.

602
3DEXPERIENCE Native : Key Parameters

During the Installation you will be queried about the following parameters:
Cheat-Sheet:
These are all default values, no need to change them.

Steps Key Value


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Your Media
01 Installer Location>AM_3DEXP_NativeApps.AllOS\9\3DEXPERIENCE_NativeA
pps\1\setup.exe

02 Choose the installation directory <Keep default>

03 Select the components you want to install in directory All products need to be selected

04 Install all additional content Yes

I want to install the DS MJPEG codec and Windows


05 Yes
Media Video 9 VCM

Tools entries in the Start Menu Yes

06 3DEXPERIENCE entries in the Start Menu Yes

3DEXPERIENCE icon on Desktop Yes

07 Install Microsoft Visual Studio Yes

08 Legacy source No Legacy Connector

603
3DEXPERIENCE Native - GA Installation

Native client installation on your host media:


1. Navigate to your:
2. <Media>\AM_3DEXP_NativeApps.AllOS\8\3DEXPERIENCE_NativeApps\1
3. Execute the setup.exe or TUI
4. Using the Cheat-sheet on the previous page, proceed to the installation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

604
3DEXPERIENCE Native - GA Installation

If you did not check your graphical pre-requisites prior to the installation.

No need to open/start the Native


application at this point in time.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

You may need to re-start the installation after updating the graphical adapter software. consult the URL and update your graphical adapter software.

Native Client includes all prerequisites and, depending on what you have already installed, you may be prompted to install "other" software.
If you already have another Native Client installed, the sequence of question may change. The installer may ask you to create an identifier for this
particular installation, "Training". It is important to note that in this situation when you apply the FixPack the FP installer may ask you which of your
Native Client you want to update, you must select the "Training" (or the value that you selected).

605
3DEXPERIENCE Native – Technical Validation

1. Upon completion of the installation, check and verify the following items to determine if your installation was successful.

a. The Errors.log file located under below location should be "Zero KB" in size
C:\Program Files\Dassault Systemes\B425\InstallData\log\<Latest Time Stamp>_CODE_win_b64_NativeApps_3DEXP.media
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Make sure you have a "DSLicSrv.txt" file under :


C:\ProgramData\DassaultSystemes\Licenses\DSLicSrv.txt
should be similar to this
I.<Your FQDN License server>:4085

606
3DEXPERIENCE Native - FP Installation

1. The Native client GA version should be installed on your host machine, we will now update it to the FP matching the platform level:
a. The Media should be: <Media>\Part_3DEXP_NativeApps.Windows64
b. Find the FP under: 1\Software\HF_NativeApps_3DEXP.HF1.Windows64\1
c. execute the "setup.exe" or TUI
d. Using the GA Cheat-sheet, proceed with the installation.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

607
3DEXPERIENCE Native – Technical Validation

1. Technical validation is identical to the GA version

The "errors.log" file located under below location should be "Zero KB" size
C:\ProgramFiles\Dassault Systemes\B425\InstallData\log\<Latest Timestamp>_CODE_win_b64_NativeApps_3DEXP.media
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

608
3DEXPERIENCE Native - Post Configuration

1. The Post configuration task consists of creating the connector information to allow you to connect to the platform later.

2. The 3DEXPERIENCE Native Client, you need to define the connection parameters:
a. In your desktop open "3DEXPERIENCE R2023x", the platform panel will automatically open allowing you to add "+" a connection to the
platform. Use the name "Mytraining“.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

609
Client Connectors: Post Configuration

3. 3DEXPERIENCE Native Client:


4. Fill out the connection information:
a. https://3dspace.mytraining.com:443/3dspace
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

5. You should now see, click Cancel, as you are not ready to connect yet.

610
3DEXPERIENCE Native – Uninstallation

1. Uninstall via the Control Panel: This task explains how to uninstall the software using the Control Panel.
a. On the Windows desktop, select the "Start" > "Control Panel" > "Programs and Features" then double-click the Uninstall a Program control
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. The program removes:


i. the installation folder
ii. all desktop items: environment icon, all entries in the Start > All Programs menu.
iii. all registry entries.

b. You may be prompted to kill any running processes which are using the version you are uninstalling.

611
Client Integration

Topics to be covered:

1. Post operations
2. Native Client
3. Client Integration *

* If you do not have client machine in


this training, there is no need of
installing the media
Client Connectors - Overview

A client is any "device" that will connect to the 3DEXPERIENCE platform server. It could be you local host machine, another VM or even an iPad,
basically any external device that is allowed to connect to the 3DEXPERIENCE platform network.

There are two types of clients:


"Native Clients" - Application code installed on your device that connects to the platform
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

"Web Clients" - A web browser like Firefox.

In this section you are only going to deal with native client scenarios, the web client connectivity exists natively within the 3DEXPERIENCE platform
server.

You will configure these three cases:


MS Office integration
CATIA V5-6R2023
3DEXPERIENCE Native Apps R2023x (CATIA)

As mentioned in the document "3DEXPERIENCE platform Installation - R2023x - Pre-Requisite Client" you should have already installed the base code.

This training is not a Client application training.

613
Client Connectors: Pre-Check

You should have already prepared the required details to proceed with this service installation, you will need the following pre-requisites:

Client Software
CATIA V5 -6R2023
3DEXPERIENCE Native Apps R2023x (CATIA)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

MS Office

You will not be able to proceed if any of these are missing. If you were unable to install the Native components on your machine the 3DS laptop can be
used for the exercise, but it will not connect to your local platform installation.

The following folders should exist: (if you used the default values)
C:\Program Files\Dassault Systemes\B33
C:\Program Files\Dassault Systemes\B425

And your MS Office 2016 or 2019 should be used.

614
Client Connectors: Key Parameters

During the Installation you will be queried about the following parameters:

Connectors are "add-ons" for specific software, most of them are automated. They will find the software and auto install. You only will be challenged
with an optional question if you have more than one installation of that particular connector. For example, if you have two CATIAV5 installations the
connector will display the two locations and ask you in which one should be used to install the connector.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The most important key parameter to know is the 3DSpace URL, that is the only information that a connector requires to reach the 3DEXPERIENCE
platform.

Cheat-Sheet :

Steps Key Value

01 OS architecture Windows64

02 3DSpace URL https://3dspace.mytraining.com:443/3dspace

C:\Program Files\Dassault Systemes\B425xcadconnectors


03 Connector Path
C:\Program Files\Dassault Systemes\Collaboration for Microsoft Client

615
Exercise: Client Integration

GA and FP installation
1. Some Connectors are used by multiple clients, such as the IEF XCAD client:

2. The Connector for CATIA V5 client is embedded with all CATIA V5 installations. You will still need the IEF XCAD client found
here:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

a. <Media> \AM_3DEXP_NativeApps.AllOS\1\IntegrationExchangeFrameworkClient\
ENOVIAIntegrationExchangeFrameworkClient.Windows64
a. <Media>\AM_3DEXP_Platform.AllOS\7\XCADDesignConnectors\XCADDesignConnectors-V6R2023x.Windows64

3. 3DEXPERIENCE Native Clients have the required connection code embedded, no client update is required.

4. For MS Office the Installer is in :


<Media>\AM_3DEXP_Platform.AllOS\2\CSV-CollaborativeIndustryInnovator\
CollaborationforMicrosoft\CollaborationforMicrosoftClient-V6R2023x.Windows64.zip
Copy/extract to "Your Installer PATH" folder in the client Machine,

30 minutes

616
Client Connectors: GA +FP Media Installer

1. Installing "ENOVIAIntegrationExchangeFrameworkClient.Windows64"
a. GA
i. Navigate to folder:
I. <Installers>\ENOVIAIntegrationExchangeFrameworkClient.Windows64\1
ii. Execute the "setup.exe" installer. Keep all default values that are proposed.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. FP
i. No fix needed it is embedded in XCADDesignConnectors

617
Client Connectors: GA +FP Media Installer : Summary
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The text is selectable, can


easily by copied into report.

618
Client Connectors: GA + FP Media Installer

1. Installing "XCADDesignConnectors-V6R2023x.Windows64"
a. GA :
i. Navigate to the folder <Installers>\AM_3DEXP_Platform.AllOS\7\XCADDesignConnectors
ii. Extract XCADDesignConnectors-V6R2023x.Windows64.1-2.zip and XCADDesignConnectors-V6R2023x.Windows64.2-2.zip
iii. Execute the "setup.exe“
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Steps Key Value

01 Choose the Installation Directory C:\Program Files\Dassault SystemesB425xcadconnectors

Select the Component you want to Connector for CATIA V5


02
install in directory Design with CATIA V5

b. FP:
i. Navigate to the folder <Media>\Part_3DEXP_OpenApps.AllOS\4\XCADConnectors
ii. Copy/extract the "HF_XCADDesignConnectors-V6R2023x.HF1.Windows64.zip" to <Your Installer PATH>
iii. Navigate to: <Installers>\HF_XCADDesignConnectors.Windows64\1
iv. Execute the setup.exe. Keep all default values that are proposed.

619
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Client Connectors: GA + FP Media Installer

620
Client Connectors: GA +FP Media Installer

1. Installing "CollaborationforMicrosoftClient.Windows64"
a. GA Navigate under the folder:
i. <Installers>\AM_3DEXP_Platform.AllOS\2\CSV-CollaborativeIndustryInnovator\CollaborationforMicrosoft
ii. Execute the "setup.exe" installer, Keep all default values that are proposed.
b. FP
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

i. Navigate to <Media>\Part_3DEXP_OpenApps.AllOS\1\Software
ii. Copy/extract the "CollaborationforMicrosoftClient.Windows64.zip" to <Your Installer PATH>
iii. Navigate to: <Installers>\CollaborationforMicrosoftClient.Windows64\1
iv. Execute the setup.exe installer. Keep all default values that are proposed.

621
Client Connectors: Technical Validation

1. Let us check the Installer logs, navigate to default folder:


a. C:\Program Files\Dassault Systemes

2. You will find the two default installation folders:


a. B425xcadconnectors
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Collaboration for Microsoft Client

3. Same as with previous installations, you will find GA & FP:


a. Log folder:
b. <App>\InstallData\log\CODE\win_b64\....media<TimeStamp>
c. You will find all logs here. Errors.log should be 0 bytes.
d. If Errors.log is not "0 bytes", check the file, it could be a simple warning.

622
Client Connectors: Technical validation

1. You should now see programs in "Programs and Features".


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

623
Client Connectors: Post Configuration

1. MS Office: You will need to do a few operations in


a. Word, PowerPoint and Excel

2. The process is the same for all the Office apps:


a. Open the application
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Check that you have the new menu "3DEXPERIENCE"

624
Client Connectors: Post Configuration

MS Office:
a. In the System tray you should have the " 3DEXPERIENCE" button, RMB and select settings:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Add / Verify the "3DSpace" server URL, and keep the other values unchanged:

625
Client Connectors: Post Configuration

MS Office:
a. Click on the "3DEXPERIENCE" Menu:
b. Then click on "Login"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. At this time it may fail because 3DSpace may not be ready, but you should see this:

626
Client Connectors: Post Configuration

For CATIA V5-6R2023 you will have to apply Service Pack 1 and Hot Fix 1 on top of your GA installation. GA installation should have been done prior to
attending the class.

a. The media will be provided by the trainer, if you have HF01 you can go ahead.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Go to <Installers>\WIN64.

c. Execute "StartSPK.exe" and the HF.

627
Client Connectors: Post Configuration

CATIA V5-6R2023:
1. In your desktop open "CATIA V5-6R2023"
2. You may be challenged to select a license and re-start CATIA.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3. Select your license and re-start

628
Client Connectors: Post Configuration

4. CATIA V5-6R2023, you need to define the connection parameters:


i. Depending on your previous configuration, you may already see:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ii. If you don’t see the ENOVIA V6 tab, Open the menu Tools > Options, then select "Compatibility", then in tab
"ENOVIAV6/3DEXPERIENCE" Enable the "Integration Mode"

629
Client Connectors: Post Configuration

5. CATIA V5-6R2023:
i. Select "CATIA V5 PowerBy 3DEXPERIENCE" in the drop down list:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

630
Client Connectors: Post Configuration

6. Go to General  Document
a. Change top most " 3DEXPERIENCE" to "Current"
b. "PowerBy 3DEXPERIENCE" must be in the second position and active
c. "Folder of the pointing document" must be above "Folder of the link“. You will get a pop up warning if the sequence is wrong.
7. Restart CATIA V5
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

631
Client Connectors: Post Configuration

8. Go to Infrastructure  Product Structure  CGR Management


a. Check the option "save level of details in cgr"
b. Check the option "Save lineic elements in cgr"
9. Close CATIA V5
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

632
Client Connectors: Uninstallation

This is a Windows "classic" uninstallation via "Programs and Features":


if you want to uninstall all DS products, order the list by publisher and you should see all "Dassault Systemes" software.

The 3DEXPERIENCE launcher could have been installed by another product, it is assumed that you are uninstalling all.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

633
Summary

3DEXPERIENCE Native Apps & Client Integration

In this lesson, you have:


 Installed the native apps
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Installed the client connectors


 Installed the V5 client.

634
Lesson 8: Functional Validation

Topics to be covered:
Introduction
Synthesis on Technical Validation
Synthesis on Admin Validation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

End-User Validation

2 hours

635
Introduction

Topics to be covered:

1. Introduction
2. Synthesis on Technical Validation
3. Synthesis on Admin Validation
4. End-User Validation
Introduction

At this stage, the 3DEXPERIENCE platform is installed and each component can properly communicate with each other.
The next step is to proceed with functional validation tests by running some basic end-to-end scenarios, that you are likely to encounter very soon after
a deployment. These tests can be used to quickly validate the core component functionality.

The core components that must be validated are:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DPassport
3DDashboard
3DSearch
FCS
3DSpace
3DComment
3DNotification
3DSwym
3D Indexing Server

637
3DEXPERIENCE platform: Core Validation Path

There are multiple ways to validate overall system integrity, the easiest method is to execute a scenario with a minimum numb er of steps that
exercises the maximum number of services.

Create 1 user : Check 3DPassport, 3DSpace and 3DDashboard


3DSpace object creation : Check 3DSpace and FCS’s (locations), 3D Indexing and 3DSearch
Client Integration : Check All integrations and FCS’s
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

0 1 2 Check
Execute basic Execute
Technical tests Administration tasks 3DEXPERIENCE
Native client integration 3
Check
CATIA V5-6 integration

4
6 5 Check
Check
Check FCS / STORE MS Office integration
3DPassport and
from Web Client
7 3DSpace
Check FCS/STORE
from Native Client

8 9 10 11
Check Check Check
Check 3DSearch
Full Text Search 3D Indexing Server 3DDashboard

638
Ensuring a proper Start

Before stating the Functional Validation you have to make sure that all 3DS Services and other supporting components are up a nd running:
Apache
TomEE+  Have all the CMD windows in visible view
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

It is a short but essential list, always keep an eye on your resources.

639
Synthesis on Technical Validation

Topics to be covered:

1. Introduction
2. Synthesis on Technical Validation
3. Synthesis on Admin Validation
4. End-User Validation
Quick Connection Tests

This first set of tests are the equivalent to "ping" tests ensuring that all services are responding and ready to be configured for the functional validation
test.

If any test fails you cannot proceed!


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Validate direct database connection using MQL


For 3DSpace

Validate STORE fcs & path


Get path for each store, check that each folder exists

Validate service connections (from server and client)


FCS URL
Web Client Connections
3DEXPERIENCE Native clients
3DEXPERIENCE Client connectors

Validate and configure full text search (3DSpace Index)


Log parameters
First FULL indexation

Note: Be patient and methodical. Keep in mind a real deployment would typically have more RAM, CPU and faster disk.

641
Exercise: First Level Validation

Open a "Command Prompt", and execute the following commands:


This will test communication from 3DSpace MQL to the database.

Test MQL server – This the MQL that should be used for all admin server tasks:
D:\3DEXPERIENCE\R2023x\3DSpace\win_b64\code\bin\mql.exe
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Matrix Query Language Interface, Version 3DEXPERIENCE R2023x HotFix 1 (64 bits)

Copyright (c) 1993-2022 Dassault Systemes.


All rights reserved.
MQL<1>set context user creator;
MQL<2>quit;

Test the desktop shortcut in the same way:

30 minutes

642
First Level Validation

These tests will check if there were any inconsistencies created during FP. This can sometimes happen during an upgrade from one FP to a newer
FP. Normally GA + initial FP applied is free of these types of issues.

Use the desktop shortcut to open MQL, execute the following commands:
MQL> set context user creator;
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

MQL> validate level 0;

If you have loaded a significant amount of data it is usually recommended to recalculate statistics for the database (optimiz ation).
1) Instead of level "0", execute validate level 4:
MQL> validate level 4;

Even though both commands use the same "validate" key word they do different tasks. Level 0 simply verifies the table structures and checks for
table corruption while Level 4 executes a recalculation of database statistics

Do not close the MQL window.

643
First Level validation

You will now validate the "STORE" objects where the files will be saved. Prior to creating any file data in the system you must understand the default file
store destinations. Using the same MQL window execute the following commands:
This is how you find out which store objects exist in the system:
I. MQL> list store; The "Image Store" has a blank space and mixed case in the name.
STORE When referring to an object you must respect the case and enclose
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Image Store object names in quotes if they have a space in the name:
MQL> print store "Image Store" ;
plmx

Now that you have the store names you can query for the FCS URL to determine which (FCS) each store object is associated with :
MQL> list store * select name fcsurl dump;
STORE ,https://fcscentral.mytraining.com/fcs
Image Store,https://fcscentral.mytraining.com/fcs
Plmx ,https://fcscentral.mytraining.com/fcs

The keyword "dump" puts the output for each object on 1 line.

You will also need to know which directory each of the store objects / FCS servers will use to store files
MQL> list store * select name path dump;
STORE ,D:\3DEXPERIENCE\data\FCS\Central\STORE
Image Store,D:\3DEXPERIENCE\data\FCS\Central\ImageStore
Plmx ,D:\3DEXPERIENCE\data\FCS\Central\plmx

Normally the installation default for the FCSURL is the "internal" web application and the path
defined during the installation process. All of this can be modified.

644
Import CA Cert to Client Machine

1. Each connection test should be done via the client machine, if there is an issue, you can fallback to the server for all tests using Firefox but you will
need to do both. "Server side" testing cannot usually be done for native clients or connectors.

2. You should have already imported the certificate in your client machine during the "Core Configuration document".
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3. Execute the command "certmgr.msc". Under "Trusted Root Certificate Authority" you should see the Server certificate.

645
Import CA Cert to Client Machine

If you do not have the certificate in your client machine refer the next slides to import it:
1. Copy the file D:\3DEXPERIENCE\conf\ssl\cacert.crt from the server directory to your client desktop then RMB and Install Certificate:
2. Choose: Place all certificates in the following store > Browse > Trusted Root Certification Authorities > OK.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

646
Import CA Cert to Client Machine

1. For IEF/CATIA V5-6 you will also need to perform the following actions:
a. Create a folder C:\3DEXPERIENCE\cert, you may need to be Administrator.
b. Copy the cacerts file from the server path:
D:\3DEXPERIENCE\Java64\jdk17\lib\security to the C:\3DEXPERIENCE\cert
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

c. Edit file "config.xml" in folder:


C:\Program Files\Dassault Systemes\B425xcadconnectors\win_b64\reffiles\IEFClientWorkspaceService

d. In the "javaoptions" tag add the following keys:


-Djavax.net.ssl.trustStore=C:\3DEXPERIENCE\cert\cacerts
-Djavax.net.ssl.trustStorePassword=changeit

e. It should look like this:

NOTE : Java location will depend on your client installation.

647
First Level Validation

The next validation steps are to ensure that you can access the URLs and
login with the platform admin user: admin_platform.

Start the TomEE+ for all services.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Remember the "MyURLs.html" that you created? You will use this file
for a quick validation.
Execute these tests using Firefox on both the server and the
client!
First we will check the URLs that have an information page but no
login page:
3DComment
FCS Central

648
First Level Validation

Execute these tests using "Firefox" on both the server and the client!
Second set of URLs with Login for each link close the IE that pops up and then
go to the next Link:
3DPassport
3DDashboard
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DSpace This will test the redirects.


3DSpace Internal
3DSpace Index
User is admin and <Your 3DSpace Index password> (Zaq1@WsxCde3)

649
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. 3DPassport
First Level Validation

650
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. 3DDashboard
First Level Validation

651
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. 3DSpace
First Level Validation

652
First Level Validation

3DSpace Index
User is "admin" and Zaq1@WsxCde3.
Click on the Administration Console.
Do not logout yet, in the next page you are going to do some minor configuration .
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

653
First Level Validation

You will now configure the log file mechanism in order to prevent excessive file growth.
Go back to the main page, on the bottom right you will see "API Console".
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The click on the “Manage” button:

654
First Level Validation

a. "Filter…" on "setLogging" then double click "setLoggingConfig"


b. Change the value for:
i. LogPurgeMaxSizeKB  From 1048576 to 204800 (1GB  200MB)

c. Click on Save and then Apply.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Then "Restart" the 3DEXPERIENCE R2023x 3DSpace Index service

655
First Level Validation

Using the same "MQL" window you have open execute these 3DSpace Index validation commands:
1. Execute:
MQL> print system searchindex file D:\3DEXPERIENCE\conf\config.xml ;

2. Edit the file and check if the server name is ok, if you need to update the SERVER name execute this command after you save your changes:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

MQL> set system searchindex file D:\3DEXPERIENCE\conf\config.xml ;

3. We will now clear the index by running the following command:


MQL> clear searchindex ;

4. Next you will execute a fresh baseline index, execute the following command:
MQL> start searchindex mode FULL ;

Note: these task are very CPU intensive, it can take days for scenarios with large amounts of data, you only do a clear and FULL index in very
particular cases.

5. Now lets have a look on the index status, execute the following command:
MQL> status searchindex ;

656
First Level Validation

1. Go back to the main page and click on "Business Console"


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Click on Mashup User Interface. Then click on "Test Search" in the search page, search for "#all"

657
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

First Level Validation

1. The search result should be similar to this:

658
First Level Validation

Following are the available commands:

To Help for all the searchindex commands:


MQL> help searchindex ;
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

To check on the status of a searchindex:


MQL> status searchindex ;

To start a baseline index:


MQL> start searchindex mode FULL ;

To start an incremental index:


MQL> start searchindex mode PARTIAL ;

To clear a searchindex from the exalead DB:


MQL> clear searchindex ;

Import & Export the config.xml file from 3DSpace database


MQL> print system searchindex file D:\3DEXPERIENCE\conf\config.xml ;
MQL> set system searchindex file <PATH>\config.xml ;

659
First Level Validation

Health & Validation

Validate searchindex via MQL command:


MQL> validate searchindex ;
The output of the command is located under:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

D:\3DEXPERIENCE\R2023x\3DSpace\logs\sxi\validate\__global__
I.Where you will find a zip that contains:
validate_searchindex_counts_....log: object Counts in DB
validate_searchindex_objects_....log: missing Objects’ physical IDs in DB and objects with missing files in the 3DSpace Index

The health of 3DSpace Index can be obtained by running this command:


 D:\3DEXPERIENCE\data\cv\data\bin\cvinit.bat status
NAME STATUS PAYLOAD PID STARTDATE
index6-sxibg0-sxii0 started - 1068 2023-02-15T07:11:15Z
indexingserver-sxibg0 started - 1912 2023-02-15T07:11:15Z
searchserver-ss0 started - 1720 2023-02-15T07:11:15Z
consolidationserver-sxiconsolidation0 started - 1916 2023-02-15T07:11:15Z
master started - 1132 2023-02-15T07:11:15Z
gateway started - 1744 2023-02-15T07:11:15Z
connectors-java0 started - 1356 2023-02-15T07:11:15Z
convert-c0 started - 1716 2023-02-15T07:11:15Z
 D:\3DEXPERIENCE\data\cv\data\bin\cvinit.bat check-indexes-up
Only checking indexes for 3dspaceindex.mytraining.com/cvdefault
All indexes are OK

660
Synthesis on Admin Validation

Topics to be covered:

1. Introduction
2. Synthesis on Technical Validation
3. Synthesis on Admin Validation
4. End-User Validation
Exercise: Second Level Validation

This is a first set of administration tasks needed for a realistic user functional tests.

3DEXPERIENCE platform Identifier setup


The "Interfix"
User creation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Central user

As with the previous validation steps, most actions will be done in one MQL window, keep it open throughout the validation process.

NOTE: Since 2021x, User creation has fundamentally changed from 3DSpace to 3DDashboard

60 minutes

662
Second Level Validation - Interfix

The interfix must be unique, otherwise when exporting data, this data tagged could be the same as another 3DEXPERIENCE platform and cause
issues during the import phase.

Proceed as below
a. Open the Collaborative Spaces Control Center widget.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Click Content Naming Rules.


c. Specify the Identifier Interfix "MyTraining" used in naming all types of content and select a Separator from the list.
i. You cannot specify different interfix values for different types of content, or different separators between different parts of the content
name. You can also choose No Separator so that nothing separates one part of the identification from the other parts.
d. For each content type that you want to update, follow these steps:
When you enter a value, the Preview box shows how the server will name content based on those values.
i. From the Content Type list, select the content type.
ii. If needed, edit the prefix value. The app provides pre-defined, unique prefixes for each type of content. Only change the prefix if
required for your business processes.
iii. Enter a suffix value.
e. Click Apply.

All content will be created using the new naming conventions. Names for existing content are not changed

663
Second Level Validation - Interfix

Login to Dashboard, Select Collaborative Spaces Control > Content Naming Rules.
Update the “Prefix”, “Suffix” and “Interfix” for the content type “Document” as shown below.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

664
Second Level Validation – Inviting Members

The users of the 3DEXPERIENCE platform are those declared by a platform administrator

There are two steps which need to be performed for user creation in the 3DEXPERIENCE Platform.

Creation of account in 3DPassport - If the member already has a 3DPassport, User can log in directly otherwise a new passport account must be
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

created. This section describes ways in which you can manage the 3DEXPERIENCE platform members.

Invitation via Email - the Members Control Center widget or the Members tab of the Platform Management or Members Management dashboards to
view, invite, edit and remove 3DEXPERIENCE platform users. The invitation is an email containing a link that opens a registration page.

665
Second Level Validation – Creation of account in 3DPassport

1. Launch 3DPassport. (Log out, if user is already logged in.)


a. Click on "Create your 3DEXPERIENCE ID".

2. Create the user as described below.


3. Once filled, click on “Register”
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3dexpcentral
Mail [email protected]

Username 3dexpcentral

First Name 3DExp


Last Name Central

Password <Your Central password>

Country France

666
Second Level Validation – Inviting Members via Email (1/4)

1. Launch 3DDashboard and login with “admin_platform"


2. Click on "Members Management"  Select "members" tab.
3. Click on "Invite Members"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

667
Second Level Validation – Inviting Members via Email (2/4)

4. In the Members tab:


a. Type the Email address “[email protected]”. To add several users use a semi-colon as separator or press the tab key.
b. To remove any of the email addresses, click X in the end of the email.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

668
Second Level Validation – Inviting Members via Email (3/4)

1. Assign the IFW (by default selected) and MDG roles.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

669
Second Level Validation – Inviting Members via Email (4/4)

1. Select “CATIA V5” as the Additional Apps. Click on Invite. This completes the 3DSpace User Configuration.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

670
Second Level Validation – User Creation (1/8)

3. Close Firefox and open 3DDashboard and logout. You will be redirected to 3DPassport. If you saved your user/password you will have to select "I
am not admin_platform", this will bring you to the default login page.

4. Login with the user : 3dexpcentral


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3dexpcentral
Login 3dexpcentral
Password <Your password>

671
Second Level Validation – User Creation (2/8)

5. Click on the 3DCompass, note that you currently only have "Business Innovation“ and “Mechanical Designer” roles, as selected
during invitation from 3DDashboard
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

672
Second Level Validation – User Creation (3/8)

6. Click on the “Company” to get a list of additional roles (which are currently not available to user”.
a) If a user wants access to any role, e.g.: “3DComponent Designer”, click on the role and click on request.
b) A message is displayed as “Role has been requested”.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

673
Second Level Validation – User Creation (4/8)

7. Logout from user “3dexpcentral” and close Firefox


8. Login to 3DDashboard with "admin_platform"
a. You can use the Direct URL or
b. 3DCompass, in My Apps
9. Note that you have a notification, click on the Notification icon.
a. Click on each "mail" and accept the request.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

674
Second Level Validation – User Creation (5/8)

10. Launch “3DSpace” app from the 3DCompass.

11. Click on “My Collaborative Spaces”  New Collaborative Space.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

12. Create new Collaborative Space with Title, Description and Visibility as shown in the below image.

675
Second Level Validation – User Creation (6/8)

13. Double click on “Training” Collaborative Space to launch.


14. Click on “Information”.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

15. Click on “Accesses”.

16. Click on “Add Member”

17. Search and add “3dexpcentral” user as Leader & Owner

676
Second Level Validation – User Creation (7/8)

14. Go to your MQL window, you will assign licenses via MQL. You can also do this via the GUI, but due to the variety of students and processes the
license list may not be identical. It is also practical to know a few paths to reach the same goal:

15. Execute the following MQL commands:


modify product PPE add person 3dexpcentral;
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

modify product MDG add person admin_platform;


modify product PPE add person admin_platform;

677
Second Level Validation – User Creation (8/8)

16. Next each user needs to validate activation of the granted roles.

17. Launch 3DSpace with both users, “admin_platform” and “3dexpcentral” and check “3DCompass” if the assigned roles are granted.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

USER  admin_platform User  3dexpcentral

678
Check 3DIndex on Server Side

Check 3DIndex status by opening the desktop shortcut.

This shortcut always points to the most recent index report located in:
a. D:\3DEXPERIENCE\data\3DIndexes\BBDMonitor\Reporting.html
b. If you want to view previous reports you will need to navigate to D:\3DEXPERIENCE\data\3DIndexes
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

For production deployments it is very important to create a job that will clean this folder.

679
Client Connections - Hosts File

If there are no client installations done, you can skip to page 704

Prior to being able to use the platform from a client you will need to verify a few things.
1. Check that the Client hosts file is updated with the VM front end server IPs, start by copying it from the server to the client, replacing 127.0.0.1 with
External Server IP Address.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Then remove lines that should never be accessible from the client (See below:Lines in bold and strikeout should be removed ).
Note: DSLS could be an exception depending on your infrastructure layout.

127.0.0.1 3dexperience.mytraining.com
database.mytraining.com
3dpassport.mytraining.com
3ddashboard.mytraining.com
untrusted.mytraining.com
3dsearch.mytraining.com
3dspaceindex.mytraining.com
External 3dindex.mytraining.com
Server 3dspace.mytraining.com
IP internal.mytraining.com
Address 3dcomment.mytraining.com
3dnotification.mytraining.com
fcscentral.mytraining.com
smtp.mytraining.com
3dswym.mytraining.com
3dswymindex.mytraining.com
help.mytraining.com

680
Client Connections - DSLS

Check That you have access to your DSLS.


Open a "Command Prompt" under your normal Operating system user.
Go to folder the following folder. It is assumed that you installed the Native Client in its default location, if not you nee d to change the root path
to match yours. C:\Program Files\Dassault Systemes\B425\win_b64\code\bin
Execute the command "DSCheckLS.exe"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Location of the File that is


being detected.

List of servers declared in


the file.

Status for all server in the


file.

Do you see your server?

681
Client Connections - Launcher

In the Windows taskbar, you should see 2 "Compass" icons


3DEXPERIENCE Launcher
Collaboration for Microsoft Client

Right click on " 3DEXPERIENCE Launcher" icon and select "Options", in the pop-up:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Go to the "Diagnostic" tab and "Run Diagnostic", all tests should be successful.
CLOSE

Depending on your client machine’s


port availability, the SSL port may be different.

682
Client Connections - Microsoft

Start "Collaboration for Microsoft Client" and select the "Settings", in the windows:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The Server URL should be "https://3dspace.mytraining.com/3dspace/"

Start "Collaboration for Microsoft Client" and select the "Login", in the windows:
Connect to with user "3dexpcentral", you should see:
Logout
Don’t use "admin_platform" to
test user connection.

683
Client Connections – Native App

1. On your client Desktop launch the Native Application shortcut "3DEXPERIENCE R2023x"

1. You should be able to login to the Native App


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Close the Native App.

684
Client Connections – CATIA V5

1. Make sure CATIA V5 is not already running


2. Launch 3DSpace  3DCompass
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3. Launch the CATIA V5 App

4. The 3DEXPERIENCE Launcher starts

685
Admin - Scenarios

Batch User creation: This is an introduction to the subject, this process will not be used for the training.

Batch user creation relies on the tool " VPLMPosImport", this tool can be used for both:
3DSpace
3DPassport
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Note: Both services require a minimum set of attributes, they are not the same for each service.

The file structures are similar but not Identical, the best way to create a template is to first create a user normally via the GUI and then use the
export tool "VPLMPosExport". You would then have to adapt a script and XLS macro to create the batch import files.

For 3DSpace this tool does much more than simple user creation, it can create Groups, organizations, roles/context, etc…

This training is not covering this topic in detail, you just need to be aware the tool exists.

686
Admin - Scenarios

Transferring files from FCS to FCS is another admin scenario that you should become familiar with. Of particular interest 3 common tasks are:
Ensure that the FCS Central has a copy of all files.
Backup strategy
Pre load files to a "slow" destination over night.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

It is important to understand that if a user is in another FCS site it is not mandatory to "FCSSynch" all the files to that l ocation. Most
synchronization will be done "on demand". The 3DSpace database keeps track of where all the files are and which file is the most recent.

All "forced" synchronizations are Admin "MQL" tasks that can range from location to location full transfers or just a subset of data.

This training is not covering this topic in detail, you just need to be aware the capability exists.

687
Admin - Scenarios
This training is not covering this topic in detail, you just need to be aware that proper process and procedures are required.
Backup is an important topic especially if you want the backups to be small and fast
First you need to know what to backup:
FCS data
Database
3DSpace Index and 3D Indexing data
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Most other files are fairly static and only need to backed up occasionally (once a month or only when they change).
a good 3DSpace Index backup is much easier than rebuilding the whole index

How to backup
Cold: Simplest method and easiest if the system is not mission critical or active 24/7
Warm: For advanced systems, requires specialized DB and system tools

When to backup
At least once a week when the system is the least busy. It is up to the customer to define what the acceptable limits are for data lost or
time lost.

How to backup, generally a good approach is


Pause all scheduled job (3DSpace Index, 3D indexer and any custom)
FCSSync from one FCS to Central FCS
Stop the services ensuring all data is committed and there are no DB connections (apache & TomEE+).
Backup DB & FCS
This will ensure data consistency

688
Admin - Scenarios

FP deployment Strategy

FP deployment on an existing system is not simply "click and install":


Do you have a well defined backup and restore strategy
Never FP directly a production system, you must dry execute the process
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Any customizations and some configurations will need to be:


Potentially re-applied
Code re-validated
A FP deployment is always considered a major system change. The impacts and details of applying a fix pack to an existing sys tem are out of
the scope for this training

For training purposes it is possible to add another FP on top of the existing system without major impact since there is no c ustom code and
very little data.

This training is not covering this topic in detail, you just need to be aware that proper process and procedures are required .

689
End-User Validation

Topics to be covered:

1. Introduction
2. Synthesis on Technical Validation
3. Synthesis on Admin Validation
4. End-User Validation
Functional Test Contents

You are now ready to test the platform with actual user scenarios, that is, data creation.

The admin scenario were presented prior to this section because in a normal installation you need to:
Create additional users
Do a backup prior to creating test data
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Create core data


And potentially even more activities (development)

By creating a few simple objects in: (Only if you have client installation available)
3DEXPERIENCE Native client
CATIA V5-6R2023
MS Office
Firefox

And using the users that are created (admin_platform, 3dexpcentral, admin, 3DIndexAdminUser), all the following services will be validated:
3DPassport
3DSpace
3DSpace Index
3DIndex
3DSearch
FCS
3DDasboard

Note: All Native clients validation will be done with user "3dexpcentral".
691
Functional Test Contents

Each test will be used to validate one or more components:


3DEXPERIENCE Native client
Client Configuration
o 3DSpace + 3DPassport access
Client & server DSLS access
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

FCS Central
3D Indexer
3DSpace VPLM Vault validation
CATIA V5-6R2020x
3DSpace STORE Vault validation
CATIA V5 -6 Integration
MS Office
MS Integration
3DSpace STORE Vault validation
3DSpace Index document indexation
Firefox
FCS

This list is by no means exhaustive, however there is no need to restate for each test, things like: 3Dpassport connections successful, login, licenses,
scheduled jobs, etc…

692
Exercise: 3DEXPERIENCE Native Client

1. Using your desktop icon "3DEXPERIENCE R2023x" start the Native client.
2. Connect with user "3dexpcentral"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3. If you have a connectivity issue, you will receive a warning and the "platforms"
panel will appear allowing you to check connection values.

30 minutes

693
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The Native application interface:


3DEXPERIENCE Native Client

694
3DEXPERIENCE Native Client

Object creation:
A product, this object is only metadata
A part, this object is geometrical and has an FCS footprint
This object also will have a 3D Index interaction which will create 2D and 3D Thumbnails
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Click on the + sign and create a Physical Product

Take note of the "Time" and the object "Name"

695
3DEXPERIENCE Native Client

It is important to distinguish the "Name" from the "Title". To see the difference, right click on the object and check the "Properties":
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The "Title" is intended for human readable text, the "Name" is used by the system and will be unique with respect to an object type and revision.

696
3DEXPERIENCE Native Client

Object creation:
If you do not see the structure, it is because the tree is collapsed, click on the arrow to expand:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

697
3DEXPERIENCE Native Client

Object creation:
Right click on the "Physical Product" and Insert 3D Part
Expand the selection, clicking on the "+"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

698
3DEXPERIENCE Native Client

Object creation:
1. Double click on the "XY" plane.
2. In the toolbar, you will see the ‘Positioned Sketch", click on it and
create a Rectangle.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3. Click on the Exit App

699
3DEXPERIENCE Native Client

Object creation:

4. Select the “Sketch” and Click on the "Pad" button.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

5. Keep all default values.


Click "OK"
4

700
3DEXPERIENCE Native Client

Object creation:
7. Save your Work
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

8. Take note of the "Time" and the object "Name"

701
3DEXPERIENCE Native Client

Object Validation:
Go to the platform server under the folder:
D:\3DEXPERIENCE\data\FCS\Central\plmx

You should see a set of newly created folders.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

This is where all the Native objects will be created including the jobs for 3D Indexer.
Check the results.  D:\3DEXPERIENCE\data\3DIndexes\BBDMonitor\Reporting.html

If you see that the time is older than our save time, you have to wait a few minutes. Keep refreshing the page.
you must go to the folder D:\3DEXPERIENCE\data\3DIndexes and check the folder time (BBDMonitor_1489522863) that
correspond to your save time.
702
3DEXPERIENCE Native Client

Object Validation:
Close the Physical Product tab.

Click on the search Icon


Search for 00*
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

703
3DEXPERIENCE Native Client

Explore the Physical product what you had searched earlier.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

704
3DEXPERIENCE Native Client - Validation

a. Client Configuration, access to


i. 3DSpace
ii. 3DPassport

b. DSLS access
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

i. 3DSpace by granting you access confirms that it can reach the DSLS
ii. Native Client by granting you access confirms that it can reach the DSLS

c. FCS Central
i. By checking the file system under the Central FS set of folders

d. 3D Indexer
i. By checking the Report shows the object being indexed
ii. By checking that the client can reach it

e. 3DSpace VPLM Vault validation


i. By finding the data under the FCS Central folder "plmx" which is linked to the vault "vplm"

705
3DEXPERIENCE – Microsoft Integration

1. Open MS Office Word


a. Login to the platform using the "Log in" button.
b. "3dexpcentral"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

30 minutes

706
3DEXPERIENCE – Microsoft Integration

1. Open MS Office Word


a. Create some text that that can be searched later on:
"XX1234XX"
NOTE : Make sure the text is unique, so when we
search we only get one result.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

b. Do a "Save as“. Select the 3DEXPERIENCE


Location as “R2023x” (You will have to create a
Bookmark Root as R2023x if not already present.
You can give any other name as well instead of
R2023x)
c. Click “Save”. Take note of the "Time" and the object
"Name“.

707
3DEXPERIENCE – Microsoft Integration

1. Open MS Office Word


a. Go to the server; under folder D:\3DEXPERIENCE\data\FCS\Central\STORE you should see a new folder.
i. The object will be similar to the picture below but may have a different file name as these names are randomly generated
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ii. Close Word. Open Firefox and login with the same user
iii. In the Home page you should see your document:
iv. Click on the search icon and search for your text:

b. MS Office Validation achieved


i. MS Integration
ii. 3DSpace STORE
iii. 3DSpace Index document indexation

708
Client Connections – CATIA V5

1. Make sure CATIA V5 is not already running


2. Launch 3DSpace  3DCompass
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3. Launch the CATIA V5 App

4. The 3DEXPERIENCE Launcher starts

709
3DEXPERIENCE CATIA V5-6 Integration

1. Similar to what was done with the Native Client you will create:
a. A Top Level Product, that by default will open when starting V5
b. Add a "New Part"
2. RMB on the "Product", select "Components", select "New Part".
3. Expand the tree (click on the "+")
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

710
3DEXPERIENCE CATIA V5-6 Integration

4. Double click on the "xy plane", then on the right side click on the "Sketch" button.
a. From the Sketcher workbench, click on the "Rectangle" button..
b. Create a rectangle, then double click on the "Part1" just one level up from the "xy plane".
NOTE - (if you do not see it, in the "View" menu use the "Fit All in" option).
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

711
3DEXPERIENCE CATIA V5-6 Integration

c. On the Part Design Workbench, click on the "Pad" button


d. Select the rectangle, keep all values and click OK.
(if you do not see it, in the "View" menu use the "Fit All in" option).
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

712
3DEXPERIENCE CATIA V5-6 Integration

5. Double-click on the top "Product". You may rename the product as “Test_Product” and part as “Test_Part” for easy identification
6. Go to the "3DEXPERIENCE" menu and "Save", accept workspace save.
i. You may be prompted for platform reconnect.
7. In the Server you should see new files in D:\3DEXPERIENCE\data\FCS\Central\plmx
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

8. Close CATIA V5-6


9. MS Office validation achieved
10. CATIA validation achieved
i. CATIA V5-6 Integration
ii. 3DSpace STORE/FCS

713
General Remarks About Native Clients and Integrations

This training is not intended to be Client application training, platform deep dive or P&O data model training.
Test were limited to OOTB behavior with minimal configuration.
These scenarios are not representative of industry best practices.
These scenarios are intended to test platform functionality only
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

You should have noticed that Files are saved in the FCS based on a few criteria:
User site
Even applies to "back end" users like "3DIndexAdmin" used by the 3D Indexer
"Stores" are linked to "Locations" and "Locations" are linked to the FCS (simplified view)

You can see that using some simple scenarios we are able to validate most of the platform quickly and efficiently.

At this time you should have closed all Native applications and integrations. The next few slide will enable us to validate additional server
components with the "3dexpcentral" user directly on the server. We will test:
3DSpace
3DDashboard
FCS

If you want you can execute these Firefox scenarios on the Client as well. Ideally all tests should be done first on the server (possible only if Windows),
and the client as well.

714
Validations

These validation steps are designed to test the server services. We previously validated 3DPassport by creating users, there is nothing more to validate
for 3DPassport. For production systems where 3DPassport is integrated to an external LDAP or 3rd party Identity Provider additional validation would be
required but this is out of the scope for this training.

Open Firefox in the server, and connect to "3DSpace" using the "3dexpcentral" user, the roles selected should be “Leader".
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

You are viewing all the latest object created in the platform:

15 minutes

715
3DSpace - Validation

1. The Security Context comprises:


a. Role
b. Group or company
c. Collaboration space
2. Click on the top right the Me icon and select My Credentials.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

716
3DSpace - Validation

1. Login with 3dexpcentral user.


2. Select Bookmark Roots and click Create Bookmark Root. Name it as My Workspace.
3. Using the menu icon, click on "Create new…" and follow the steps indicated in the image
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

717
3DSpace - Validation

4. Click on Create New to create New Bookmark.


5. Create a new folder called My Bookmark in the workspace.
Observe that all red text fields are mandatory in the creation panel.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

718
3DSpace - Validation

5. Open Folder: D:\3DEXPERIENCE\R2023x\3DPassport\win_b64\Passport\webroot\resources\img\3DS_logos


You should see the file 3DS_Logo_RGB_Blue.png.
6. Drag and drop that image into workspace wksp_test1
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

7. Go to folder D:\3DEXPERIENCE\data\FCS\Central\ImageStore
8. Check the FCS behavior you should see a new folder
(You may not see a "new" folder if the FCS choses a file a name the corresponds to an existing folder).

719
3DSpace - Validation

9. Select My Bookmark and select Create New > Document.


10. Select a small text file, an ideal text file would have a special keyword inside that could be searched.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

720
3DSpace - Validation

The new document is created containing the text file you choose. Click the Viewer icon to view the contents.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

11. The FCS Folder should have a new file


D:\3DEXPERIENCE\data\FCS\Central

12. Open a new tab in your browser and open the URL:
https://fcscentral.mytraining.com/fcs/servlet/fcs/about

721
3DSpace - Validation

1. Launch search with string “00*, if the command is successful 3DSearch is available on the platform:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

722
3DDashboard - Validation

In your 3Dspace Compass, click on "3DDashboard"


3DDashboard will appear in "Firefox" new tab
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

723
3DDashboard - Validation

Click the “Compass” and Launch the "Calculator":


This tests a few basic Dashboard tools
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

It is just as easy to switch 3DSpace from 3DDashboard if you started directly in 3DDashboard .

724
3DDashboard - Validation

Create a new 3DDashboard, on the top right click on the "Add (+)"
Use the value proposed in the image, you should see the "Dash_test1" appear
Click on the expand arrow of you new dashboard
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

725
Summary

Functional Validation

In this lesson, you have completed the Functional Validation:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Introduction
Synthesis on Technical Validation
Synthesis on Admin Validation
End-User Validation

726
3DEXPERIENCE platform On-Cloud

3DS cloud solution offers many advantages for new customer or customer with a small or inexistent IT group
When you combine virtualization with fully automated provisioning services for operating environments and access via a public
or private network, you enter the realm of cloud computing
Open source and other free solutions, like Java, Apache, PHP, Python, MySQL and Linux have helped push the envelope by
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

permitting a fully “write once, run anywhere” paradigm which allow a company to construct cloud implementations within their
enterprise to manage virtualization complexity, and to deploy some of their workload into cloud-enabled environments

25 Min

727
Table of Contents

3DEXPERIENCE platform On-Cloud


Chapter topics:

3DEXPERIENCE on the cloud provides you with a complete suite of  3DS Offerings
industry-leading solutions which gives you everything you'll need to
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

bring your idea to reality, including design & engineering,  Cloud Model Definitions
manufacturing & production, simulation, governance & collaboration.  Network & Repository
 Support & SLA
Break free of IT constraints and bring together all aspects of your  Public Cloud Advantages
business on a single cloud-based platform to increase collaboration,  Operations & Management
improve execution and accelerate innovation.
 Offering Key Differentiators
 Compliancy
 Security Audit
 Eligibility
 Education & Communities
 Native Applications

728
3DEXPERIENCE platform On-Cloud – 3DS Offerings

Multiple Companies Company One Company

3DEXPERIENCE users
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Virtual Private network


https://Internet Customer’s Information system
Dassault Systèmes DS Cloud Provider Data Center Customer Data Center
Control Center
SaaS SaaS SaaS
Software as a Service Software as a Service Software as a Service

PaaS
Platform as a Service

Monit oring & Operat ions IaaS IaaS IaaS


done by cert ified operat ors Infrastructure as a Service Infrastructure as a Service Infrastructure as a Service
(including provisioning, maint enance
and upgrade)

Public Cloud Privat e Cloud (CA) Dedicat ed Cloud (CA)


Private Cloud is an extension of the customer’s Dedicated Cloud is part of the customer information
information system system, no customer admin access (OS)

S&M Business, Large & Large scale & Enterprise Government, Large scale &
Enterprise customers customers Enterprise customers

Internet access Corporate Network Access Virtual Private Access


Mutualized virtual resources Dedicated virtual resources Dedicated virtual resources
Mutualized physical resources Mutualized physical resources Dedicated physical resources

729
3DEXPERIENCE on Cloud : Responsibilities

PUBLIC/
DEDICATED
PRIVATE
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DEXPERIENCE Platform
SaaS

3DEXPERIENCE Platform Provided and


Provided and
PaaS operated by operated by

DASSAULT DASSAULT
3DEXPERIENCE Platform SYSTEMES SYSTEMES

IaaS

Physical Resources
(hardware)

Datacenter
CUSTOMER
(building, electricity, cooling, security,
backup, management)

730
3DEXPERIENCE platform On-Cloud – Cloud Model Definitions

A customer cloud solution is not the “3DEXPERIENCE platform on Cloud” solution


They are considered “On-Premises”, without any management by Dassault Systèmes
This does not imply that those solution are not supported, HMA required!
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

SaaS (Software as a Service)


Industry Solution Experience & Industry Process Experience
Roles and options
Upgrade and hot fixing

PaaS (Platform as a Service)


3DEXPERIENCE platform services
Deployment, Monitoring and Operation services by 3DS

IaaS (Infrastructure as a Service)


Data center, Physical computing resources, Underlying network infrastructure
Operating Systems, Middleware, database, Compute and storage virtual resources
Scaling, security, backup…

731
3DEXPERIENCE platform On-Cloud – Network & Repository

Dassault DS Data Center


Systèmes Native Apps (installation)
Control Center SaaS o Media can be procured from
Software as a Service
Public Cloud the 3DS Cloud.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

PaaS
On-Cloud

o Alternatively, installation can


Platform as a Service be from a “Network Path”,
which is located On-
Monit oring &
Operat ions done by
IaaS Premises (media file cache).
Infrastructure as a Service
cert ified operat ors
(including provisioning,
maint enance and upgrade)
3DSOpen Native
Applications

Web Apps
o All traffic is https
o TLS1.2 min
On-Premises

https:// DSLauncher
o All data repository is Media Cache
located on 3DS
datacenters (FCS).
3DSOpen
Native
Applications
732
3DEXPERIENCE platform On-Cloud – Support

Always ON: Service continuity is a priority


3DS SLA - https://www.3ds.com/terms/sla/
High Availability
Monthly availability 99.5%
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Backups - Minimum 1 per 24 hours


Max. Downtime during Upgrades – 4hrs (Upgrades are made during non-business hours)
DRP (Disaster Recovery Plan) using multiple data centers
24/7 support
Support:
Online User Excellence Center is the team dedicated on supporting on 3DEXPERIENCE platform users
The 3DEXPERIENCE platform user's Community is public and accessible with a 3DEXPERIENCE ID

733
3DEXPERIENCE platform On-Cloud – Public Cloud Advantages

Advantages:
World accessibility
Near instant deployment
No IT required on the customer side
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DS federated file storage


Europe
Any device anywhere in the world US West US East Korea
Tokyo
Easy supplier integration China
Cross company Cloud collaboration India
Globally synchronized updates
No LDAP required Singapore
No E-mail Server required (send from platform)
No extra backup system required

Security restrictions Australia

No storage for custom widgets Public Cloud*


No Dashboard with internet pages
*subject to change
No device control

734
3DEXPERIENCE platform On-Cloud – Key Differentiators

3DS Public Cloud 3DS Private Cloud 3DS Dedicated Cloud


Hardware IaaS (DS) shared between customers IaaS dedicated to one customer
Operated by Operated by Certified 3DS Cloud Operators
Assigned by 3DS to one of the 3DS platform Locations based on where the largest number of users Customer’s premises
Location of Data
are located
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

All 3DEXPERIENCE apps and services 3dx apps and services accessed over All 3DEXPERIENCE apps and services
Network Access accessed securely over public internet company’s intranet which is connected to accessed securely over customer’s network
the cloud via site to site VPN
Shared 3DPassport Service Dedicated 3DPassport Service
User Authentication
Manual 2 Factors Authentication Optional: LDAP integration or SAML v2 or 2 Factors Authentication
Defined by 3DS globally : Defined by 3DS:
URL
https://... 3dexperience.3ds.com https://... Tenant/customer specific … 3dexperience.3ds.com
Network Security Client communication secured via https/tls v1.2 using 256-bit encryption
IaaS Security ISO 27001 on Infrastructure/Continuous monitoring and risk assessment of vulnerabilities To be Specified with customer
PaaS and SaaS Security Security auditing, vulnerability scans and live alerts of security events
Configuration capabilities Baseline behavior + Organization modelling + EKL (knowledge) + Additional App widgets development
Data Model No Data Model Customization Unified Typing Customization Tools are available – DBS role
Customization
Native using any 3DS data centers Native using 3DS data centers (need one site to To be designed with customer
Distributed File Storage
site VPN configuration per used 3DS data center)
Cross company Native for other public cloud users (upon Need for supplier to access customer intranet + provided licenses
collaboration invitation)
3DEXPERIENCE Managed globally by Dassault Systèmes Under Dassault Systèmes responsibility with
Update management limited freeze period.
735
3DEXPERIENCE platform On-Cloud – Compliancy SECURED &
ALWAYS UP TO DATE

o ISO 9001:2015 - Dassault Systèmes is o ISO 27001:2017 - 3DEXPERIENCE on


certified on Quality Management the cloud is certified
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

System
SaaS
o ISO 27001:2017 (Information Security
o ISO 9001:2015 Certificate Scope:
Management)
Design, development, delivery,
PaaS deployment, cloud operations, and o ISO 27701:2019 (Security techniques
support of software Extension to ISO/IEC 27001)

IaaS
o ISO 27001:2017 - 3DS IaaS Providers are certified on Information Security Management
System

o ISO 27017:2015 (information security controls applicable to the provision and use of cloud
services)
o ISO 27018:2019 (objectives, controls and guidelines for implementing measures to protect
Personally Identifiable Information (PII) in accordance with the privacy principles in ISO/IEC 29100
for the public cloud computing environment)
o ISO 27701:2019 (Security techniques — Extension to ISO/IEC 27001)

736
3DEXPERIENCE platform On-Cloud – Security Audit

Open Web Application Security Project standard (OWASP)


is used as a baseline
Dassault Systèmes warranties no known vulnerability to one
of the OWASP Top Ten threats is present in a new Release
of the 3DEXPERIENCE platform.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

DS R&D development process has been updated to


ensure this commitment:
Training for developers and testers
Internal and External Code review
Penetration tests performed by an external Organization
Correction of vulnerabilities

737
3DEXPERIENCE platform On-Cloud – Eligibility

Check you eligibility


First Go to www.3ds.com

Cloud Eligibility tool is the easiest and quickest way to check the compatibility of
your environment with 3DEXPERIENCE platform on cloud
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

https://www.3ds.com/support/3dexperience-platform-on-cloud-support/eligibility/

Prerequisites:
o 3DEXPERIENCE user ID
o Administrator privilege to
run the downloaded EXE.

Then Run the executable and


get your report.

738
3DEXPERIENCE platform On-Cloud – Education & Communities

SWYM Communities for all 3DS authenticated users


https://www.3ds.com/support/users-communities/
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

From 3DEXPERIENCE University access

739
3DEXPERIENCE platform On-Cloud – Native Applications 1/2

Optionally for customers that require the Native application, this media will need to be installed locally in each
workstation.
Note: The Native application cloud code is of exclusive use with that particular cloud tenant, specially don’t mix it
with any ON-Premises versions.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

An eligibility test is also available to ensure the performance, security and quality of the product, to be run on each client:
https://www.3ds.com/support/3dexperience-platform-on-cloud-support/eligibility/
You should respect all supported policies:
Certified Workstations
Certified Configurations for VDI
Browser
Internet Options

A Native Apps installation tool is required with 3DEXPERIENCE Platform: “The 3DEXPERIENCE Launcher”
https://www.3ds.com/support/documentation/resource-library/single/3ds-launcher/
The cloud Native Application code is distinct from the “On-Premises” version and should not be mixed
This may need to be distributed and installed by the local IT Administrator
This a similar operation for customer that use 3DDrive

740
3DEXPERIENCE platform On-Cloud – Native Applications 2/2

As we know the Native application is a rather large piece of code to download, so many customer that have the
possibility of hosting a local network path with the Native application installation media will do so.

The advantages are many


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Less traffic between the client and the 3DS tenant


Unusually local network is much faster
Extra security control from IT on the media, possible installation privileges not grated to users
More control on the pre-requite by IT for Native application ensure a successful installation & customer configuration

On-Cloud On-Premises
Dassault Systèmes
Control Center https://

3DSOpen Native
DSLauncher
Public Cloud

Applications
Media
Cache
“customer data center”
SaaS, PaaS &
3DSOpen Native
IaaS Applications

741
Lesson 19: 3DEXPERIENCE platform On-Cloud

Take away
The 3DS Cloud bring together all aspects of your business on a single cloud-based platform to increase collaboration, improve
execution and accelerate innovation, remember:
3DS Cloud solution are ready to go!
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Easy and fast implementation with minimal customer side intervention


Global datacenter availability
Secure and with an impressive growth!

Cloud values
Immediate Access : Easy to deploy & ready to use on any device without an IT investment
Cost Saving : No infrastructure, no management, by default highly available & backup
All-in-One Solution : A complete package offering (SaaS, PaaS, IaaS)
Accessible Technology : A portfolio of enterprise-class technologies (CATIA, SOLIDWORKS, SIMULIA, DELMIA, ENOVIA)
A path for success
Onboarding : Continuous onboarding program, tailored to your needs
E-learning : E-learning modules to master our solutions
Community : Dedicated community for personalized expert advice
Offerings : Public, Private & Dedicated Cloud

30min

742
Appendix A: Installation - Training Client Prerequisites

If a PC/laptop is not provided in this training, the client machine, you MUST perform these actions in your personal laptop
that you will bring to the training.

Table of Content
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Introduction
Client prerequisites
Client Software
CATIA V5-6R2023 GA + SP1 (if available) Installation
Note: If SP2 not available, you need SP1 AND HF1
http://media.3ds.com/support/PLMCollaborationCATIAV5/ENOVIA_CompatibilityMatrix.pdf
Microsoft Office 2016 Validation

30 minutes

743
Introduction

The actions requested in this annex are needed to execute the integrations installation relative to some of the client software.

This is a server installation training not a Native Client training. However, you will be asked to install some client Integ rations listed below that
require some preexistent client software:
CATIA V5-6R2023
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Microsoft Office

This chapter will introduce the prerequisite information and key messages for the requisite client software installations.

A compatible level of Service Pack and Hotfix with the level of the 3DEXPERIENCE platform server should be installed for the Native App on the
Client slide.
See this link for reference:
http://media.3ds.com/support/PLMCollaborationCATIAV5/ENOVIA_CompatibilityMatrix.pdf

744
Client - Prerequisites

First check that your laptop Hardware is compatible:


You will perform some simple checks to ensure compatibility. For Certified Hardware compliancy details refer to:
o https://www.3ds.com/support/certified-hardware/
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

745
Client - Prerequisites

Then check that your laptop Software is compatible:


Check CATIA V5-6 "Program Directory" for host compatibility:
https://www.3ds.com/support/documentation/program-directories/
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

746
Client - Prerequisites

Example, extract from the "Program Directory" for machine prerequisites:

Resources:
15 GB of free space on your fastest drive (SSD is recommended)
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Physical machine should have at least 8 GB of RAM (more is better)


4 CPUs
Operating System
Windows 10 (for versions consult the pdf file indicated below)
https://media.3ds.com/support/certfied_sotfware/Windows10/Windows-10-support-DS-products.pdf

File System for installation


File system of the installation directory must be NTFS on Windows Operating systems
License Software
Access to a DSLS server with MD2 licenses.

747
Client - Prerequisites

Example, extract from the "Program Directory" for machine prerequisites:

Application Specifics
CATIA V5-6R2023
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

IBM Semeru Runtime Open Edition for Java 17.0.3 or


Oracle JDK 17.0.x,with x>=3
MS Office
Refer to "Browser and Native Apps Client H/W& S/W Requirements" in the Program Directory for supported Microsoft
Office releases for "Collaboration for Microsoft"

748
Client - Prerequisites

Support Policy for Browsers


CATIA V5
Internet Explorer 11

Support Policy for .NET run time Environment


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

CATIA V5
Microsoft .NET Embedded in Windows 10

749
CATIA V5 Overview
CATIA supports digital product definition (3D Design) and simulation, it provides functionality for multiple disciplines such as:
Mechanical Design
Product Synthesis
Analysis
Shape Design & Styling Note: that some installers
Equipment & Systems Engineering are OS independent.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Machining

Using your DS account download the "GA, Service Pack and HotFix" media or ask your IT organization to procure a copy for you.
It is recommended that you download all media on you local machine. Without a specialized hardware solution, it is not workin g in a VM.

Copy and extract the media to <Your Media PATH>

<Installer PATH> = any folder


CATIA V5 -6 media folder structure should look like the example below which is having free space for
<Media>\CATIA_P2.win_b64\1 example D:\

You can use either


CATIA P1, P2 or P3

750
CATIA V5-6R2023 GA: Configuration & Key Parameters

During the Installation you will be asked about the following parameters : You can use either CATIA P1, P2 or P3

Cheat-Sheet: Steps Key Value


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

01 Global platform Installer <Media>\CATIA_Px.win_b64\1\setup.exe

02 Destination Folder D:\Dassault Systemes\B33

03 Environment Directory C:\Program Files\Dassault Systemes\CATEnv

04 Choose the type of setup you prefer Complete – All the software will be installed

Orbix Configuration:
Port number for Orbix daemon 1570
05
Starting port number for daemon-execute server 1590
Range for daemon-execute server 200

06 Servers Timeout 60

07 Yes, I want to setup the ENOVIA Vault Client Yes

Creates a Startup icon on the desktop Yes


08 Creates a Startup shortcut in the Start Menu Yes
Creates administrative tools entries in the Start Menu Yes

09 I want to install Online Documentation No

751
CATIA V5-6R2023 GA Installation

1. Software: CATIA V5-6R2023 GA


a. Navigate to your <Your Media PATH>
b. Start the GUI installer corresponding to your OS
c. Using the Cheat-sheet, proceed to the installation.
d. Keep default Destination Folder  "Next >"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

i. Accept the folder creation  "Yes"

752
CATIA V5-6R2023 GA Installation

2. Software: CATIA V5-6R2023 GA

a. Keep default Environment folder  "Next >"


i. Accept the folder creation  "Yes"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

753
CATIA V5-6R2023 GA Installation

3. Software: CATIA V5-6R2023 GA


a. A complete install  "Next >"
b. Keep default options  "Next >"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

754
CATIA V5-6R2023 GA Installation

4. Software: CATIA V5-6R2023 GA


a. Keep default timeout  "Next >"
b. Keep default vault  "Next >"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

755
CATIA V5-6R2023 GA Installation

5. Software: CATIA V5-6R2023 GA


a. Keep the Default Ports  "Next >"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

756
CATIA V5-6R2023 GA Installation

6. Software: CATIA V5-6R2023 GA


a. Keep Default shortcut creation  "Next >"
b. Don’t install the documentation  "Next >"
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

757
CATIA V5-6R2023 GA Installation

7. Software: CATIA V5-6R2023 GA


a. Proceed to the install  Install
It should take about 20 minutes with P3
b. Unselect "I want to launch CATIA…"  Finish
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

758
CATIA V5-6R2023 SP1 Installation

1. 8. Install the V5-6R2023 SP1 after GA.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

You NEED to commit the


service pack before installing
the HotFix (next step)

759
CATIAV5 – Technical Validation

Upon completion of the installation, check and verify the items below to ensure your installation has been successful.
Make sure you have a "DSLicSrv.txt" file under following directory:
Make sure you
C:\ProgramData\DassaultSystemes\Licenses don’t create
Make sure that you using the correct license server name and port DSLicSrv.txt.txt !
o <License server FQDN>:4085
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

First startup test with CATIAV5, will require you to select a license:
MD2

It is highly recommended to install the


CATIA V5 Service Pack + Hotfix in line with
the 3DEXPERIENCE platform Fixed Pack.

760
CATIAV5 – Uninstallation

This task explains how to remove the CATIA Version 5 application on Windows

a. In the Windows Start menu type: "Add or remove programs”


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

i. Select “Apps & features", you will find


"Dassault Systemes Software Version 5-6
Release 2023 (B33)"
ii. Select it and click “Uninstall”
or
The Uninstall.bat in the installation folder

761
MS Office - Overview

Collaboration for Microsoft integrates the 3DEXPERIENCE platform with Microsoft Office applications (Microsoft Word, Excel, PowerPoint, Project,
Outlook, and Office 365 desktop applications) enabling you to manage documents and capture information in a quick and easy way.

In this Training you will integrate Microsoft Office 2016 or 2019 or 365 with 3DEXPERIENCE platform
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

There is no detail on the installation of Microsoft Office 2016 or 2019 or 365 in this document. Consult your local IT if you need support for this
product.

762
Summary

Summary

You have achieved the client side preparation.

You have achieved:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 CATIA V5 3DEXPERIENCE connection configuration


 MS Office connector plugin and configuration

763
Appendix B: Installing Documentation

You can install the Documentation. You can refer to this when required using the Help.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

40 minutes

764
About Documentation

The Documentation is the life line to many requirements, change and new features.

The Documentation is not a tutorial it is a reference document, in order to be effective it must get familiar.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

765
Exercise: Installing Documentation

In this exercise, you will install Documentation.


a. Installing the GA Documentation
b. Validate the GA Documentation
c. Installing FP Documentation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

d. Validating FP Installation Technically


e. Validating Documentation Installation Functionally

40 minutes

766
Installing the GA Documentation (1/3)

Technical validation will only validate the installer procedure.

1. Target path: C:\Program Files\Dassault Systemes\B425doc

2. Installer error log should be empty in:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\DOC\<Language>\...media-<Latest timestamp>\Errors.log & *Stderr.txt


Size should be 0 bytes

If during the dialog you had to reset some values due to typos, these errors will
appear here, you may need to check any message and evaluate its importance.

767
Installing the GA Documentation (2/3)

1. Log to the Operating System as dsadmin

Content is found at the following location:


<Media>\Documentation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

You will find the normal installer,


GUI: setup.exe
TUI: StartTUI.exe Ensure that some installers are Operating System independent.
In some condition installers will want to use a legacy temp folder C:\Temp we recommend
creating this folder ensuring read/write for all users.

Navigate to your <Media>\Documentation path


Start the GUI installer corresponding to preference

1. Using the Cheat-sheet, proceed to the installation:


Use all default values proposed

768
Installing the GA Documentation (3/3)

The installation is going to query about the parameters below:

Cheat-Sheet :

Parameters Values
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Installer location <Media>\AM_3DEXP_NativeApps.AllOS\2\3DEXPERIENCE_Documentation\1

Installation Directory C:\Program Files\Dassault Systemes\B425doc

Documentation Select IFW (Others) and CSV (from Cross-Industry) only


components

769
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Key Parameters (1/2)

3DSpaceInternal.
Stop the TomEE+ for 3DSpace and

770
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

Key Parameters (2/2)

771
Installing the FP Documentation

There is no Global 3DEXPERIENCE platform installer for FP. So, you must proceed with one service at a time.

1. Use the Service Installer:


a. Go to your platform media folder: <Media>\Part_3DEXP_Documentation.AllOS
You will find:
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

GUI: setup.exe
TUI: StartTUI.exe

2. Proceed with the update using the same key values as used for the GA.

772
Post Installation Configuration

1. Update the Virtual host for the help in the 3dexpereince.conf file.
# Virtual host configuration for help (OnlineDoc) service
<VirtualHost *:443>
ServerName help.mytraining.com
ServerAlias help
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

ErrorLog logs/help.err
TransferLog logs/help.log
CustomLog logs/help.cus "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"
LogLevel warn
SSLEngine on
SSLProxyEngine on
SSLCertificateFile D:\3DEXPERIENCE\conf\ssl\help.crt
SSLCertificateKeyFile D:\3DEXPERIENCE\conf\ssl\private.key

# Replace D:\3DEXPERIENCE\R2023x\Doc with the location of your installed doc


DocumentRoot "<Documentation installation location>"
<Directory "/">
Require all granted
</Directory>
</VirtualHost>

773
Post Installation Configuration

2. Modify the file emxSystem.properties in D:\3DEXPERIENCE\R2023x\3DSpace\STAGING\ematrix\properties\emxSystem.properties

3. Update the following:


#Help directory
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

emxFramework.Help.URL=https://help.mytraining.com

4. Generate new war files for 3DSpace and 3DSpaceInternal.

5. Modify the file D:\3DEXPERIENCE\TomEE\TomEE3DSpace\webapps\3dspace\WEB-INF\classes\emxSystem.properties, when TomEE+ is


stopped.

6. Restart TomEE3DSpace and TomEE3DSpaceInternal.

774
Post Installation Configuration

1. Open the Internet Explorer browser.

2. Select Internet options > Security > Custom Level.

3. Select Scripting > Scripting of Java applets.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

4. Select Enable and click OK.

5. Open the 3DEXPERIENCE platform client.

6. Select Me > Preferences > General > Help > Technical


Documentation.

7. Change the URL to https://help.mytraining.com.

775
Validating the FP Installation Technically

Technical validation will only validate the installer procedure.

1. Target path : C:\Program Files\Dassault Systemes\B425doc

2. Installer error log should be empty in:


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

<Code>\InstallData\log\DOC\<Language>\...media-<Latest timestamp>\Errors.log & *Stderr.txt


Size should be 0 bytes

If during the dialog you had to reset some values due to typos, these errors will appear
here, you may need to check any message and evaluate its importance.

776
Validating the Documentation Installation Functionally

Also, you can view the documentation using the Help menu within the platform.

1. Login to the 3DEXPERIENCE platform.

1. Select Help > Help.


© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

The documentation appears.

3. Navigate to the page according to the requirement.

777
Uninstalling the Documentation

1. This is a know-how section.


2. Perform these instructions only if you are required to re-install.

Perform the below steps manually:


1. Select Windows > Control Panel > Programs > Programs and Features.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

2. Select Dassault Systemes Documentation 3DEXPERIENCE R2023x and click Uninstall.

778
Exercise Recap: Installing the GA Documentation

In this exercise, you have:

 Installed the GA Documentation


 Validated the GA Documentation
 Installed FP Documentation
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

 Validated FP Installation Technically


 Validated Documentation Installation Functionally

779
Appendix C: Configuring Extra SMTP Server

The 3DEXPERIENCE platform is more web based than prior version, and many communication are done via mail. A mail Server is a non 3DS
middleware, very particular to each enterprise. So it’s not really possible to do any recommendation on this software, except for the fact that it must
works.
For the training FakeSMTP tool is being used.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

10 minutes

780
Configuring Extra SMTP Server

1. The training is using FakeSMTP from https://nilhcem.github.io/FakeSMTP/index.html

1. Create the Folder D:\SMTP\MailStore and a empty batch file D:\SMTP\StartSMTP.bat.

1. Unzip the download file into D:\SMTP, delete the zip file afterward to save space.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

1. Edit the StartSMTP.bat file as follow:


REM My SMTP
echo off
@title "My SMTP"
set JAVA_HOME=D:\3DEXPERIENCE\Java64\jdk17
set SMTP_HOME=D:\SMTP
set SMTP_OUT=D:\SMTP\MailStore
set SMTP_PORT=2525
set SMTP_SERVER=smtp.mytraining.com
%JAVA_HOME%\bin\java -jar "%SMTP_HOME%\fakeSMTP-2.0.jar" -s -o "%SMTP_OUT%" -p "%SMTP_PORT%" -a "%SMTP_SERVER%"

781
Configuring Extra SMTP Server

6. Create a desktop shortcut for the bat file for easy start.
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

7. Save and execute the batch file, the following screen should appears.

782
© Dassault Systèmes | Confidential Information | 4/24/2023 | ref.: 3DS_Document_2020

3DEXPERIENCE, the Compass icon, the 3DS logo, CATIA, SOLIDWORKS, ENOVIA, DELMIA, SIMULIA, GEOVIA, EXALEAD, 3D VIA, BIOVIA, NETVIBES, IFWE and 3DEXCITE are commercial trademarks or registered trademarks of Dassault
783
Systèmes, a French “société européenne” (Versailles Commercial Register # B 322 306 440), or its subsidiaries in the United States and/or other countries. All other trademarks are owned by their respective owners. Use of any Dassault
Systèmes or its subsidiaries trademarks is subject to their express written approval.

You might also like