Technical Documentation

Integration guide

SE Suite 2.0
DC TE .E N 00022
Rev 16
SoftExpert Excellence Suite (SE Suite) is the most comprehensive corporate solution for integrated management
of excellence and business compliance.

SoftExpert Excellence Suite (SE Suite) offers a set of multilingual modules that are natively integrated and fully
Web-based to automate the processes required to improve and optimize the different business areas at
organizations. This boosts the quality of management, cuts operating costs and facilitates compliance with the
main market norms and regulations.

The solution also supplements and enhances the use of corporate management systems and is integrated with
main market ERPs through connectors that may be developed based on the company’s specific needs.

The information contained herein is subject to change without notice. If you find inconsistent information, please
report it in writing to our support.

The entire risk of the use or the results from the use of this document remains with the user. Unless otherwise
noted, the companies, organizations, products, domain names, e-mail addresses, logos, people, places, and
events depicted in examples herein are fictitious. No association with any real company, organization, product,
domain name, e-mail address, logo, person, place, or event is intended or should be inferred.

C omplying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under
copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or
transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for
any purpose, without the express written permission of SoftExpert.

SoftExpert may have patents, patent applications, trademarks, copyrights, or other intellectual property rights
covering subject matter in this document. Except as expressly provided in any written license agreement from
SoftExpert, the furnishing of this document does not give you any license to these patents, trademarks,
copyrights, or other intellectual property.

This software and documentation may provide access to or information on content, products, and services from
third parties. SoftExpert is not responsible for and expressly disclaim all warranties of any kind with respect to
third-party content, products, and services. SoftExpert will not be responsible for any loss, costs, or damages
incurred due to your access to or use of third-party content, products, or services.

C opyright © 2017 SoftExpert Software SA. All rights reserved.

 Table of Contents
1 - Introduction
.......................................................................................................................................... 5
2 - Typographical conventions
.......................................................................................................................................... 6
3 - Integration possibilities
.......................................................................................................................................... 7
4 - Integration via database
.......................................................................................................................................... 9
4.1 - Technical overview
.......................................................................................................................................... 10
4.2 - Interface data template
.......................................................................................................................................... 11
4.3 - Data load in the interface
.......................................................................................................................................... 17
4.4 - XLS file..........................................................................................................................................
structure definition 18
4.5 - Diagnosis and correction or errors
.......................................................................................................................................... 20
4.6 - Published interfaces
.......................................................................................................................................... 21
4.6.1 - Action
.......................................................................................................................................... 22
4.6.2 - Administration
.......................................................................................................................................... 25
4.6.3 - Storeroom
.......................................................................................................................................... 60
4.6.4 - Asset
.......................................................................................................................................... 86
4.6.5 -..........................................................................................................................................
Calibration 111
4.6.6 -..........................................................................................................................................
SPC 118
4.6.7 -..........................................................................................................................................
Competence 127
4.6.8 -..........................................................................................................................................
Time control 130
4.6.9 -..........................................................................................................................................
Performance 145
4.6.10..........................................................................................................................................
- Document 166
4.6.11..........................................................................................................................................
- Inspection 187
4.6.12..........................................................................................................................................
- Supply 202
4.6.13..........................................................................................................................................
- Maintenance 210
4.6.14..........................................................................................................................................
- PDM 217
4.6.15..........................................................................................................................................
- Project 241
4.6.16..........................................................................................................................................
- Survey 257
4.6.17..........................................................................................................................................
- Waste 259
4.6.18..........................................................................................................................................
- Risks 268
4.6.19..........................................................................................................................................
- Test 291
4.6.20..........................................................................................................................................
- Training 293
5 - Integration via web services
.......................................................................................................................................... 304
5.1 - Technical overview
.......................................................................................................................................... 305
 5.1.1 -..........................................................................................................................................
Basic HTTP authentication 306
5.2 - Published web services
.......................................................................................................................................... 307
5.2.1 -..........................................................................................................................................
Administration 308
5.2.2 -..........................................................................................................................................
Asset 339
5.2.3 -..........................................................................................................................................
Calibration 362
5.2.4 -..........................................................................................................................................
Document 370
5.2.5 -..........................................................................................................................................
Generic 399
5.2.6 -..........................................................................................................................................
Incident 413
5.2.7 -..........................................................................................................................................
Inspection 431
5.2.8 -..........................................................................................................................................
Maintenance 445
5.2.9 -..........................................................................................................................................
PDM 450
5.2.10..........................................................................................................................................
- Performance 472
5.2.11..........................................................................................................................................
- Physical file 475
5.2.12..........................................................................................................................................
- Problem 478
5.2.13..........................................................................................................................................
- Project 496
5.2.14..........................................................................................................................................
- Request 514
5.2.15..........................................................................................................................................
- SPC 519
5.2.16..........................................................................................................................................
- Supply 531
5.2.17..........................................................................................................................................
- Time control 540
5.2.18..........................................................................................................................................
- Workflow 551
6 - Update..........................................................................................................................................
history 573
 Introduction 5

Chapter I

Introduction
This document aims at defining the technical specifications and criteria required for the integration of different
information systems with SoftExpert Excellence Suite (SE Suite).

Who should read this document

This guide contains useful information for:

§ Any person who needs to understand the integration architecture and its operation;

§ IT professionals (mainly an integrator or DBA) responsible for implementing the integration between a

third-party system and SE Suite;

§ IT professionals in charge of maintaining the integration architecture, who need to understand the

integration process to be able to identify possible problems.

Integrations via the template made available in SE Suite should be executed by IT professionals knowledgeable about
web services or databases (preferably an integrator or DBA).

§ For integration via Web Services the user will need to have knowledge in the SOAP protocol, in tools construction, and

consumption of Web Services.

§ For integration via Database it will be necessary to manipulate the data of a particular table where the solution is

installed.

Objective

The integration architecture was designed as part of a SDK, following a standard for importing data from any
source into SE Suite, and for extracting data from the output obtained from the data import process to a given
destination.

ATTENTION

Although providing support for recent versions of third-party software packages and patches, SoftExpert has no control
over those software updates and, thus, cannot ensure compatibility with their products. In any case, contact the
supplier for product specifications and further details about compatibility.

Integration guide — SE Suite 2.0

 Typographical conventions 6

Chapter II

Typographical conventions
This document uses the conventions described in the table below to distinguish the elements in the text.

Convention

EXAMPLE Environment variables, status codes, and tool names.

Names of programs and selected tokens, such as command parameters and environment
Example
variables that need to be emphasized.

[Example] Elements that may be clicked in the user interface (such as buttons, for example).

Example Paths and file names

Variables provided by the user and new tokens entered in the text, names of additional
Example
documents.

<Example> Variables provided by the user that replace the content between the < and > characters.

Example Examples of codes, examples, displayed or presented texts, and error messages.

Table 1.1 - Typographical conventions of this docum ent regarding the text.

# mkdir <folder_name>

Table 1.2 - Convention used to represent com m ands.

This text box displays the content of the file being edited.

Table 1.3 - Convention used to represent files (content).

While using this manual, users will find different strategies used to call their attention to important information.
The images that indicate this information are displayed below:

Displays important details about a specific functionality that must be taken into consideration and/or that facilitate the use
of the system. A link will be made available if the functionality was already described elsewhere in the documentation.

Alert to indicate a functionality or action that, when not executed correctly, may harm a step of the system use.

Integration guide — SE Suite 2.0

 Integration possibilities 7

Chapter III

Integration possibilities
1. Integration of portals and/or client legacy systems to start a workflow/process within SE Suite.

§ The integration may be carried out by using an external startup API, technically detailed in the

DCTE.PT00002 document (Process start API).

§ Or the SoftExpert startup Web Services may also be used. The SoftExpert Web Services are described

in detail in the Integration via web services chapter.

Other workflow actions are also released from the moment the WEB Service is used, such as activity execution,
filling in attributes and form fields, upload of attachments, etc. (Web Services online documentation
http://<domain>/se/ws/wf_ws.php).

2. Process startup through e-mail receiving.

§ It may also be performed through customization.

3. Use of another BI to view SE Suite data.

§ For that, the client BI must access SE Suite tables directly and assemble the desired views. The data

dictionary of our product is available online in component SE Configuration, through the SE

Configuration Tool Editor SQL menu "Documentation" button.

4. Integration of client external systems to create and add several data into SE Suite.

§ For that type of demand, we make available interface tables and our own Web Services, both are

described in detail in the Integration via database and Integration via web services.

5. Read data from external databases to be used in SE Suite.

§ To do that, we have the external attributes option within the application. The details of how to

configure external attributes are found in the manual/help of component SE Administration.

§ And, regarding the components based on SE Process, we have the external applications option, in

which the user can test external information, return some type of data, etc., either by using the Web
Service concept or even a customized application (by means of customization).

The same concept may be applied to load form field list data. In that case, there is no option for direct connection
with the external attribute, but small routines and a few connectors may be developed.

Integration guide — SE Suite 2.0

 Integration possibilities 8

6. From SE Suite, save information in external systems.

§ To do that, it is possible to use Web Service interfaces (if the external service contains them), export

to data files (TXT, CSV) for import through the external system, or then save the data directly into the
external system database.

§ And, if in the case of SE Process-based components, we have the option to configure external

applications where it is possible to configure the clients of Web Service natively (except for
authentication and architecture particularities, in which the specific client would have to be
implemented).

7. Integration when Hosting.

§ The restriction applies exclusively to the infrastructure made available for the tooling to be used. For

example, if the connection is direct between the databases, they should enable a DBLINK or be in the
same network (Dedicated VPN). If there is need for file transfer, the fileservers must be available in the
cloud, and so on.

§ The indicated orientation and architecture in these cases is the use of a Web Service.

8. Possible integrations to be performed with SAP ERP.

§ May be performed by any SAP tooling (ABAP, XI, RFC, etc.), being them dependent mostly on the type

of contract the customer has. However, the practice is that implementations directly into SAP are
usually performed by the customer IT team or by SAP consultants.

The same understanding may be applied to any other ERP, i.e., the SoftExpert team must map the data
availability method of the ERP in question. From that, the methods mentioned above are directed to.

Integration guide — SE Suite 2.0

 Integration via database 9

Chapter IV

Integration via database

The Overview technician section, contains an operation diagram of the architecture of integration;

The Interface data template section, displays each field as well as of the ADINTERFACE table and of the header
of the file for .xls import;

The Interface data load section, defines how the data load is done in the ADINTERFACE table;

The Definition of the XLS file structure defines how to use the .xls file, and how it should be filled in;

The Diagnosis and correction of errors section, describes how the correction of records that were not imported
successfully should be done;

The Published interface section, defines all the interfaces published in the system, and what should be filled in
each one of them;

Integration guide — SE Suite 2.0

 Integration via database 10

4.1 - Technical overview

The picture below represents the SE Suite data flow scheme. This diagram indicates possible ways of system
integration, and the flow of data after they are in the system interface (Middleware).

SE Suite makes available two operations in this architecture: 1 – Interface data import, 2 – Data output from
the operations executed during the data import. Both search for/make available data in the interface table.

Third-party information systems will only have access to this interface, preventing this information system from
interfering in the rest of the environment. No trigger should be generated in the interface, thus avoiding the
interruption of any database transaction, providing transparency to the responsibilities between SE Suite and
third-party software systems.

IMPORTANT!

All information about the data input in SE Suite will be performed through the interface made available and displayed in
this guide, not allowing the direct insertion of data into the SE Suite tables.

Integration guide — SE Suite 2.0

 Integration via database 11

4.2 - Interface data template

The ADINTERFACE table is the interface where all records from all imports are stored to be later imported.
Third-party information systems are responsible for inserting and searching for the data in this table. See
below the specifications of each field in this table.

ADINTERFACE

Column Type Precision Description

C DINTERFAC E NUMERIC 10 Sequential field.

C DISOSYSTEM NUMERIC 10 C ode of the system which the import will be performed into.

C DSC HEDULE NUMERIC 10 C ode of the scheduling that executed the import.

Import sequence referring to the scheduling that imported

NRSEQUENC E NUMERIC 10
this record.

DTEXEC UTION DATE - Date on which the record is imported.

QTHRINIT NUMERIC 10 Start time of the record import (seconds).

QTHRFINISH NUMERIC 10 End time of the record import (seconds).

FGIMPORT NUMERIC 2 Import status.

FGOPTION NUMERIC 2 Type of the object to be imported.

Defines that only the FLFIELD01 field will be used for this
FGBLOBOPTION NUMERIC 2
import.

Description of the inconsistency found during the import

DSERROR TEXT 4000
process.

NMFIELD01 TEXT 255 Import parameter.

NMFIELD02 TEXT 255 Import parameter.

NMFIELD03 TEXT 255 Import parameter.

NMFIELD04 TEXT 255 Import parameter.

NMFIELD05 TEXT 255 Import parameter.

NMFIELD06 TEXT 255 Import parameter.

NMFIELD07 TEXT 255 Import parameter.

NMFIELD08 TEXT 255 Import parameter.

NMFIELD09 TEXT 255 Import parameter.

NMFIELD10 TEXT 255 Import parameter.

Integration guide — SE Suite 2.0

 Integration via database 12

ADINTERFACE

Column Type Precision Description

NMFIELD11 TEXT 255 Import parameter.

NMFIELD12 TEXT 255 Import parameter.

NMFIELD13 TEXT 255 Import parameter.

NMFIELD14 TEXT 255 Import parameter.

NMFIELD15 TEXT 255 Import parameter.

NMFIELD16 TEXT 255 Import parameter.

NMFIELD17 TEXT 255 Import parameter.

NMFIELD18 TEXT 255 Import parameter.

NMFIELD19 TEXT 255 Import parameter.

NMFIELD20 TEXT 255 Import parameter.

NMFIELD21 TEXT 255 Import parameter.

NMFIELD22 TEXT 255 Import parameter.

NMFIELD23 TEXT 255 Import parameter.

NMFIELD24 TEXT 255 Import parameter.

NMFIELD25 TEXT 255 Import parameter.

NMFIELD26 TEXT 255 Import parameter.

NMFIELD27 TEXT 255 Import parameter.

NMFIELD28 TEXT 255 Import parameter.

NMFIELD29 TEXT 255 Import parameter.

NMFIELD30 TEXT 255 Import parameter.

NMFIELD31 TEXT 255 Import parameter.

NMFIELD32 TEXT 255 Import parameter.

NMFIELD33 TEXT 255 Import parameter.

NMFIELD34 TEXT 255 Import parameter.

NMFIELD35 TEXT 255 Import parameter.

NMFIELD36 TEXT 255 Import parameter.

NMFIELD37 TEXT 255 Import parameter.

NMFIELD38 TEXT 255 Import parameter.

Integration guide — SE Suite 2.0

 Integration via database 13

ADINTERFACE

Column Type Precision Description

NMFIELD39 TEXT 255 Import parameter.

NMFIELD40 TEXT 255 Import parameter.

NMFIELD41 TEXT 255 Import parameter.

NMFIELD42 TEXT 255 Import parameter.

NMFIELD43 TEXT 255 Import parameter.

NMFIELD44 TEXT 255 Import parameter.

NMFIELD45 TEXT 255 Import parameter.

NMFIELD46 TEXT 255 Import parameter.

NMFIELD47 TEXT 255 Import parameter.

NMFIELD48 TEXT 255 Import parameter.

NMFIELD49 TEXT 255 Import parameter.

NMFIELD50 TEXT 255 Import parameter.

NMFIELD51 TEXT 255 Import parameter.

NMFIELD52 TEXT 255 Import parameter.

NMFIELD53 TEXT 255 Import parameter.

NMFIELD54 TEXT 255 Import parameter.

NMFIELD55 TEXT 255 Import parameter.

NMFIELD56 TEXT 255 Import parameter.

NMFIELD57 TEXT 255 Import parameter.

NMFIELD58 TEXT 255 Import parameter.

NMFIELD59 TEXT 255 Import parameter.

NMFIELD60 TEXT 255 Import parameter.

NMFIELD61 TEXT 255 Import parameter.

NMFIELD62 TEXT 255 Import parameter.

NMFIELD63 TEXT 255 Import parameter.

NMFIELD64 TEXT 255 Import parameter.

NMFIELD65 TEXT 255 Import parameter.

NMFIELD66 TEXT 255 Import parameter.

Integration guide — SE Suite 2.0

 Integration via database 14

ADINTERFACE

Column Type Precision Description

NMFIELD67 TEXT 255 Import parameter.

NMFIELD68 TEXT 255 Import parameter.

NMFIELD69 TEXT 255 Import parameter.

NMFIELD70 TEXT 255 Import parameter.

NMFIELD71 TEXT 255 Import parameter.

NMFIELD72 TEXT 255 Import parameter.

NMFIELD73 TEXT 255 Import parameter.

NMFIELD74 TEXT 255 Import parameter.

NMFIELD75 TEXT 255 Import parameter.

NMFIELD76 TEXT 255 Import parameter.

NMFIELD77 TEXT 255 Import parameter.

NMFIELD78 TEXT 255 Import parameter.

NMFIELD79 TEXT 255 Import parameter.

NMFIELD80 TEXT 255 Import parameter.

NMFIELD81 TEXT 255 Import parameter.

NMFIELD82 TEXT 255 Import parameter.

NMFIELD83 TEXT 255 Import parameter.

NMFIELD84 TEXT 255 Import parameter.

NMFIELD85 TEXT 255 Import parameter.

NMFIELD86 TEXT 255 Import parameter.

NMFIELD87 TEXT 255 Import parameter.

NMFIELD88 TEXT 255 Import parameter.

NMFIELD89 TEXT 255 Import parameter.

NMFIELD90 TEXT 255 Import parameter.

NMFIELD91 TEXT 255 Import parameter.

NMFIELD92 TEXT 255 Import parameter.

NMFIELD93 TEXT 255 Import parameter.

NMFIELD94 TEXT 255 Import parameter.

Integration guide — SE Suite 2.0

 Integration via database 15

ADINTERFACE

Column Type Precision Description

NMFIELD95 TEXT 255 Import parameter.

NMFIELD96 TEXT 255 Import parameter.

NMFIELD97 TEXT 255 Import parameter.

NMFIELD98 TEXT 255 Import parameter.

NMFIELD99 TEXT 255 Import parameter.

NMFIELD100 TEXT 255 Import parameter.

NMFIELD101 TEXT 255 Import parameter.

DSFIELD01 TEXT 4000 Import parameter.

DSFIELD02 TEXT 4000 Import parameter.

DSFIELD03 TEXT 4000 Import parameter.

DSFIELD04 TEXT 4000 Import parameter.

DSFIELD05 TEXT 4000 Import parameter.

DSFIELD06 TEXT 4000 Import parameter.

DSFIELD07 TEXT 4000 Import parameter.

DSFIELD08 TEXT 4000 Import parameter.

DSFIELD09 TEXT 4000 Import parameter.

DSFIELD10 TEXT 4000 Import parameter.

DSFIELD11 TEXT 4000 Import parameter.

DSFIELD12 TEXT 4000 Import parameter.

DSFIELD13 TEXT 4000 Import parameter.

DSFIELD14 TEXT 4000 Import parameter.

DSFIELD15 TEXT 4000 Import parameter.

FLFIELD01 BLOB - Import parameter.

Integration guide — SE Suite 2.0

 Integration via database 16

IMPORTANT!

§ Every record type will be saved in this table, even after the import or even if there are errors during the import;

§ What distinguishes one record from another is the system code (CDISOSYSTEM) and the import type you intend to

execute (FGOPTION);

§ The CDINTERFACE field, in addition to, being the primary and sequential key, is what defines the import sequence of

the items inserted into the interface.

Both CDISOSYSTEM and FGOPTION, as well as the other fields related to the imports already published in SE
Suite, will be described in detail in the subsequent chapters. Each of these published imports has a different
quantity of data, both of required and complementary data.

Integration guide — SE Suite 2.0

 Integration via database 17

4.3 - Data load in the interface

Partners are in charge of developing and maintaining the programs responsible for loading the data into the
interface, due to specifications that depend on third-party software.

The programs that are responsible for loading the data must read the information from a source repository
(database, XLS, CSV and XML files, among others) and write this information in the ADINTERFACE interface
available in SESUITE. In the import process, users are responsible for deleting the processed records and for
treating exceptions and errors that may occur during the import through the system. Whereas in the data
output process, third-party software systems are responsible for deleting the records consumed in the
interface.

It is important to point out that the architecture does not store deleted information, either for an already
imported or a not yet imported record. Therefore, once a record is deleted from the system or directly from the
interface, there is no place in the Integration architecture to keep the deleted data.

Integration guide — SE Suite 2.0

 Integration via database 18

4.4 - XLS file structure definition

The ADINTERFACE table may also be fed through an XLS file. For that, it is necessary to create a file with a
header containing the same fields existing in the ADINTERFACE table.

IMPORTANT!

All the fields must be placed in the header, even if not used. The fields must all be written with uppercase and follow the
order below:
CDINTERFACE, DSERROR, FGIMPORT, FGBLOBOPTION, FGOPTION, CDISOSYSTEM, QTHRINIT,
QTHRFINISH, DTEXECUTION, NRSEQUENCE, NMFIELD01, NMFIELD02, ..., NMFIELD101,
DSFIELD01, DSFIELD02, ..., DSFIELD15

The file must contain in its name the word seimport, and should be inside the C:\Inetpub\SE\web\import
file. When executing a scheduling, this folder is verified and, if there are one or more files, the integration
architecture will load the found records to the interface.

After import, the XLS file goes to the C:\Inetpub\SE\web\import\imported directory, if the data is captured

successfully, otherwise, it will go to the C:\Inetpub\SE\web\import\error directory, if a problem occurs

during the process import.

IMPORTANT!

The C:\Inetpub\SE directory is defined in the product installation.

Examples of names:

§ 20.05.seimport.xls

§ seimport.20.05.xls

§ _seimport_.xls

Integration guide — SE Suite 2.0

 Integration via database 19

If the multi-database feature is being used, the domain and one more underline character must be added
before the word seimport. Examples of names for the domain www.softexpert.com:

§ 20.05.www.softexpert.com_seimport.xls

§ www.softexpert.com_seimport.20.05.xls

§ _www.softexpert.com_seimport_.xls

In addition to the XLS automatic search feature and insertion of data into the interface through the scheduling,
there is the possibility of loading the data through the system on the Import data screen (SE Configuration
Tool Import Tracking). On this screen, it is possible to work with three integration resources:

Import data (Import spreadsheet)

Export data (Export spreadsheet)

Import template (Expose import template spreadsheet)

With the first, it is possible to export the data from the import tasks list through the export button, which
builds a file in the XLS format with the header containing all the interface data. Once exported, the data may
be edited and imported back into the system through the second button shown above, which imports the
data. The second resource, not only imports the data that were already in the import data list, but it also adds
new items, facilitating the import of specific data. This last one, exports a base spreadsheet that corresponds
to the correct template for file import

Integration guide — SE Suite 2.0

 Integration via database 20

4.5 - Diagnosis and correction or errors

During the import process of the data contained in the interface table, there may be errors that usually occur
due to the existence of records with the same data in the database, or due to the absence of some data
required for that type of record.

If any error of this type has occurred, its verification may be performed through the Import tracking screen,
located in the SE Configuration component (Configuration Tool Import Tracking). On this screen, it is
possible to view the records that were, or not, successfully executed. It is possible to use the Filter by status
to filter the records and display only the ones with errors. The reason of the error is displayed in the "Error
description" column, making it possible to diagnose the problem and then fix it.

Data correction and reimport

After verifying the description of the error and filtering the desired records, it is then possible to use the
"Export spreadsheet" button, located on the toolbar, to export the data set again and fix it.

All records listed in the grid will be exported. To only export records with errors, filter the data for only such records to
be displayed in the grid.

To correct them, open the generated XLS and correct the data according to the description of the error (e.g.: if
the error indicated that the record already exists, change the column that has the duplicated values). All
values in the DSERROR column will be deleted, and the ones in the FGIMPORT column will be updated to “1”.
Keep the values in the CDINTERFACE, FGOPTION, and CDISOSYSTEM columns the same, since they are used to
find the record to be replaced in the interface table.

After correcting the XLS, just use the "Import spreadsheet" button to replace the data in the ADINTERFACE
table. Note that after the file is sent to the server, the records that were updated will again be marked for
import and will be re-imported according to the Import scheduling set on the server.

Integration guide — SE Suite 2.0

 Integration via database 21

4.6 - Published interfaces

For each group of items shown below, a unique identifier was created, which may be scheduled through the
scheduling screen (SE Configuration Tool Import Scheduling). This identifier is made up of the
abbreviation of the module and the abbreviation of the item to be imported.

This section contains the following topics:

§ Action

§ Administration

§ Storeroom

§ Asset

§ Calibration

§ SPC

§ Competence

§ Time control

§ Performance

§ Document

§ Inspection

§ Supply

§ Maintenance

§ PDM

§ Project

§ Survey

§ Waste

§ Risks

§ Test

§ Training

Integration guide — SE Suite 2.0

 Integration via database 22

4.6.1 - Action

This section contains the following topic:

§ ACTIT - Item data import

Integration guide — SE Suite 2.0

 Integration via database 23

4.6.1.1 - ACTIT - Item data import

This import template enables to insert/delete:

§ Data of an item:

Note: The type of item may not be edited.

To insert each of these items, it is necessary to follow the standard documented below.
Insert/delete item

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

98 - C ode of component SE Action.

C ode of the operation to be performed:

1 - Insert item. If it exists, edits the existing

item;
FGOPTION X NUMERIC 2
2 - Insert item. If it exists, returns an error;

3 - Edit item. If it does not exist, returns an

error.

NMFIELD01 X TEXT 255 Item ID #.

NMFIELD02 X TEXT 255 Item name.

NMFIELD03 X TEXT 255 Item type.

Unit cost. When not entered, it will be inserted as

NMFIELD04 NUMERIC 10
$0,00.

Measurable?

1- Yes;
NMFIELD05 NUMERIC 2
2- No.

Note: If not entered, the default value is 1.

Integration guide — SE Suite 2.0

 Integration via database 24

NMFIELD06 TEXT 255 Measurement unit ID #.

DSFIELD01 TEXT 4000 Item description.

Example of item insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,
NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, DSFIELD01) VALUES (1, 1, 1,
98, 'XPTO', 'Item XPTO', 'TP-XPTO', 50, 1, 'UN', 'XPTO item to be used by the
Production team.');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (2, 1, 2, 98, 'XPTO1', 'Item XPTO1', 'TP-XPTO');

Delete item

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

98 - C ode of component SE Action.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
4 - Delete item.

NMFIELD01 X TEXT 255 Item ID #.

NMFIELD03 X TEXT 255 Item type.

Example of item deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,
NMFIELD03) VALUES (12, 1, 4, 98, 'XPTO', 'TP-XPTO');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD03) VALUES (13, 1, 4, 98, 'XPTO1', 'TP-XPTO');

Integration guide — SE Suite 2.0

 Integration via database 25

4.6.2 - Administration

This section contains the following topics:

§ ADCOM - Company import (customer/manufacturer/supplier)

§ ADCTC - Company contacts import

§ ADMACT – Import of activity

§ ADMATR - Attribute import

§ ADMATRPROFVL - Value of the employee profile attribute

§ ADMATRVAL - Import of attribute values

§ ADMCPNATRASS - Import of association of attributes to companies

§ ADMDEP - Department data import

§ ADMEMPLOYEEPROF – Edits the employee profile data

§ ADMMEA - Import of measurement units

§ ADMPOS - Position data import

§ ADMTEAM - Team import

§ ADMTEAMASSOC - Associates a department, position, or user with a team

§ ADMUSR - User data import

§ ADMUSRCOMP - Full import of user data

Integration guide — SE Suite 2.0

 Integration via database 26

4.6.2.1 - ADCOM - Company import

(customer/manufacturer/supplier)

This import template enables to insert/edit/delete:

§ Company data (customer/manufacturer/supplier).

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete company (customer/manufacturer/supplier)

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

17 - Insert company. If it exists, edits the

FGOPTION X NUMERIC 2
existing record;

18 - Delete company.

NMFIELD01 X TEXT 255 C ompany ID (required field for deletion).

C ompany name (required field for

NMFIELD02 X TEXT 255
deletion).

NMFIELD03 TEXT 255 Address.

NMFIELD04 TEXT 255 C ity.

NMFIELD05 TEXT 255 State.

NMFIELD06 TEXT 255 C ountry.

NMFIELD07 TEXT 255 Postal code.

NMFIELD08 TEXT 255 Phone #.

NMFIELD09 TEXT 255 FAX #.

Integration guide — SE Suite 2.0

 Integration via database 27

NMFIELD10 TEXT 255 Home Page.

C ustomer company:

NMFIELD11 X TEXT 255 1 - Yes;

2 - No.

Supply company:

NMFIELD12 X TEXT 255 1 - Yes;

2 - No.

Manufacturing company:

NMFIELD13 X TEXT 255 1 - Yes;

2 - No.

NMFIELD14 TEXT 255 Description.

C ompany code (E.g.: C orporate taxpayer

NMFIELD15 TEXT 255
registry).

NMFIELD16 X TEXT 50 C ompany type ID #.

Associate the company with the

component. Separate the component
NMFIELD17 TEXT 255
codes with “;”.

Example:109;107.

Example of company insertion/editing/deletion (customer/manufacturer/supplier):

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD16) VALUES (1, 1, 17, 153,
'SoftExpert', 'SOFTEXPERT SOFTWARE S/A', '1', '1', '1', 'Soft');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD08, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD16) VALUES (2, 1, 17,
153, 'SoftExpert', 'SOFTEXPERT SOFTWARE S/A', '+55 47 2101-9900', '1', '1', '1',
'Soft');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD16) VALUES (3, 1, 18, 153, 'SoftExpert', 'SOFTEXPERT SOFTWARE
S/A', 'Soft');

Integration guide — SE Suite 2.0

 Integration via database 28

4.6.2.2 - ADCTC - Company contacts import

This import template enables to insert/edit/delete:

§ Company contact data.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete company contacts

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

19 - Insert company contact. If it exists,

FGOPTION X NUMERIC 2
edits the existing record;

20 - Delete company contact.

NMFIELD01 X TEXT 255 C ompany ID (required field for deletion).

NMFIELD02 X TEXT 255 C ontact name (required field for deletion).

NMFIELD03 TEXT 255 Department.

NMFIELD04 TEXT 255 Position.

NMFIELD05 TEXT 255 Phone #.

NMFIELD06 TEXT 255 Fax #.

NMFIELD07 TEXT 255 E-mail.

NMFIELD08 TEXT 255 C omments.

Default contact:

NMFIELD09 TEXT 255 1 - Yes;

2 - No.

Integration guide — SE Suite 2.0

 Integration via database 29

Example of company contacts insertion/editing/deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (1, 1, 19, 153, 'SoftExpert', 'John Smith');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD07, NMFIELD09) VALUES (2, 1, 19, 153, 'SoftExpert', 'John Smith',
'[email protected]', '1');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (3, 1, 20, 153, 'SoftExpert', 'John Smith');

Integration guide — SE Suite 2.0

 Integration via database 30

4.6.2.3 - ADMACT – Import of activity

This import template enables to insert/delete:

§ Activity data

To insert each of these items, it is necessary to follow the standard documented below.

Insert/delete activity data

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 21 - Insert activity;

22 - Delete activity.

NMFIELD01 X TEXT 50 Team ID # (required field for deletion).

NMFIELD02 X TEXT 255 Activity name

DSFIELD01 TEXT 4000 Activity description.

Example of insertion/deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, DSFIELD01) VALUES (1, 1, 21, 153, 'DES', 'Software development',
'Software' development activity description');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (1, 1, 22, 153, 'DES');

Integration guide — SE Suite 2.0

 Integration via database 31

4.6.2.4 - ADMADP – Import of relationship of activity with

position or department

This import template enables to insert/delete:

§ Activity associated with position or department

To insert each of these items, it is necessary to follow the standard documented below.

Insert/delete

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;0

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 23 - Insert activity;

24 - Delete activity.

NMFIELD01 X TEXT 50 Team ID # (required field for deletion).

NMFIELD02 X TEXT 50 Position ID #

NMFIELD03 TEXT 50 Department description

Note: Fields NMFIELD02 and NMFIELD03 - only one must be filled in.

Example of insertion/deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (1, 1, 23, 153, 'DES', 'PROG.');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (1, 1, 24, 153, 'DES', 'PROG.');

Integration guide — SE Suite 2.0

 Integration via database 32

4.6.2.5 - ADMATR - Attribute import

This import template enables to add new attributes to the SE Suite components. Follow the standard
documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
96 - Inserts a new attribute.

NMFIELD01 X TEXT 255 Attribute ID #.

NMFIELD02 X TEXT 255 Attribute name.

NMFIELD03 X TEXT 255 User ID #.

Attribute type.

1 - List of values;
NMFIELD04 X TEXT 255
2 - Non-discrete;

3 - External.

Attribute data type.

List of values:

1 - Text;

2 - Numeric;

3 - Date;
NMFIELD05 X TEXT 255
5 - C urrency.

Non-discrete:

1 - Text;

2 - Numeric;

3 - Date;

Integration guide — SE Suite 2.0

 Integration via database 33

4 - Memo;

5 - C urrency.

External:

1 - Text.

Selection mode.

The 'List of Values' and 'External' attribute

types must inform the 'Selection Mode'.
NMFIELD06 TEXT 255
Accepted values:

1 - Zoom;

2 – C ombo.

The 'List of Values' attribute type can

inform whether the attribute will be
NMFIELD07 TEXT 255
'Multivalued'. Accepted values:

1 - Multivalued

Associate attributes with the component.

NMFIELD8 TEXT 255 Separate the component codes with “;”.

Example:109;107.

Field format:

NMFIELD09 TEXT 255 1 - Single mask;

2 - Regular expression.

DSFIELD01 TEXT 4000 Single format or regular expression mask.

Example of the function to insert attributes:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07) VALUES (1, 153, 1,
96, 'ATRIB_DATA', 'Date list', 'Peter',’1’,’3’,’2’);

Integration guide — SE Suite 2.0

 Integration via database 34

4.6.2.6 - ADMATRPROFVL - Value of the employee profile

attribute

This import template enables to insert/edit:

· Values of the employee profile attributes

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

153

C ode of the operation to be performed:

26 – Inserts the value for an attribute. If

FGOPTION X NUMERIC 2
existent, edits it

NMFIELD01 X TEXT 255 Employee ID #

NMFIELD02 X TEXT 255 Attribute ID #

Attribute value.

Standards to enter date type data:

NMFIELD03 TEXT 255 · dd/mm/yyyy

· yyyy-mm-dd.

DSFIELD01 TEXT 4000 Attribute value (Non-discrete, memo)

Integration guide — SE Suite 2.0

 Integration via database 35

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01)
VALUES (1, 1, 153, 26, '0001', ' Attribute', '100', 'Description');

Integration guide — SE Suite 2.0

 Integration via database 36

4.6.2.7 - ADMATRVAL - Import of attribute values

This import template enables to insert values to attributes already saved in SE Suite. Follow the standard
documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
95 - Inserts a value to an attribute.

NMFIELD01 X TEXT 255 Attribute ID #.

Attribute value (list of attribute values

NMFIELD02 TEXT 255
mandatory).

Use as default (List of attribute values

mandatory):

1 - The value of the attribute will be the

TEXT 255
NMFIELD03 default for the attribute;

2 - The value of the attribute will not be

the default for the attribute.

NMFIELD04 X TEXT 255 User ID #.

Address of the database server (external

NMFIELD05 TEXT 255
attribute mandatory).

Alias/Database path (external attribute

NMFIELD06 TEXT 255
mandatory).

Database user (external attribute

NMFIELD07 TEXT 255
mandatory).

Database password (external attribute

NMFIELD08 TEXT 255
mandatory).

Integration guide — SE Suite 2.0

 Integration via database 37

Database type (external attribute

mandatory).

Supported databases:

1 - INTERBASE;

2 - MSSQL;

3 - MSSQL (ODBC );

4 - ORAC LE < 8.05;

NMFIELD09 TEXT 255 5 - ORAC LE 8/9 (SERVIC E NAME);

6 - ORAC LE 8/9 (SID);

7 - ORAC LE (ODBC );

8 - DB2 (ODBC );

9 - INFORMIX;

10 - ORAC LE 8/9 (TNS NAME);

11 - MYSQL;

12 - POSTGRESQL;

SQL to be executed in the database

NMFIELD10 TEXT 255
(external attribute mandatory).

NMFIELD11 TEXT 255 View field (external attribute mandatory).

The values accepted for the import of dates must follow one of the following standards:

§ YYYY-MM-DD

§ DD/MM/YYYY

The import of values for non-discrete attributes is not permitted.

Example 1: Insert a value to an attribute at the top of the list:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (1, 153, 1, 95, ' ATRIB_DATA', '30/01/1990',
1, 'Peter');

Example 2: Insert a value to an external type attribute:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08, NMFIELD09, NMFIELD10,
NMFIELD11) VALUES (1, 153, 1, 95, 'ETEXTO', 'eduardo', 'des061', 'SESUITE12',
'user_01', '111111', 2, 'SELECT YEAR, MODEL FROM CAR’, 'MODEL');

Integration guide — SE Suite 2.0

 Integration via database 38

4.6.2.8 - ADMCPNATRASS - Import of association of

attributes to companies

This import template enables to associate an attribute value with a company from the SE Administration
component. Follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 94 - Association of an attribute with a
company.

NMFIELD01 X TEXT 255 C ompany ID #.

NMFIELD02 X TEXT 255 Attribute ID #.

NMFIELD03 X TEXT 255 Attribute value.

The values accepted for the import of dates must follow one of the following standards:

§ YYYY-MM-DD

§ DD/MM/YYYY

Example of the function to insert attribute associations:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 153, 1, 94, 'Company_01', 'ATRIB_DATA ',
'01/30/1990')

Integration guide — SE Suite 2.0

 Integration via database 39

4.6.2.9 - ADMDEP - Department data import

This import template enables to insert/edit:

§ Data of a department;

§ Relationship between department and position.

To insert each of these items, it is necessary to follow the standard documented below.

Insert department

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
9 - Insert department.

NMFIELD01 X TEXT 255 Department ID #.

NMFIELD02 X TEXT 255 Department name.

NMFIELD03 TEXT 255 Upper level department ID #.

NMFIELD04 TEXT 255 C ompany ID #.

Example of a department insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (18, 1, 9, 153, 'tec', 'Technology');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (19, 1, 9, 153, 'adm', 'Administration', 'tec');

Integration guide — SE Suite 2.0

 Integration via database 40

Insert/delete relationship between department and position

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

10 - Insert relationship between

FGOPTION X NUMERIC 2 Department and Position;

12 - Delete relationship between

Department and Position.

NMFIELD01 X TEXT 255 Department ID #.

NMFIELD02 X TEXT 255 Position ID #.

Example of deletion/insertion of the relationship between department and position:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (20, 1, 10, 153, 'tec', 'prog');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (21, 1, 10, 153, 'adm', 'ana');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (22, 1, 12, 153, 'tec', 'prog');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (23, 1, 12, 153, 'adm', 'ana');

Integration guide — SE Suite 2.0

 Integration via database 41

Delete department

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
11 - Delete department.

NMFIELD01 X TEXT 255 Department ID #.

Example of department deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (24, 1, 11, 153, 'tec');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (25, 1, 11, 153, 'adm');

Integration guide — SE Suite 2.0

 Integration via database 42

4.6.2.10 - ADMEMPLOYEEPROF – Edits the employee profile

data

This import template enables to edit the following employee profile data:

§ Educational level;

§ Educational level status;

§ Birth date;

§ Hire date;

§ Termination date;

§ Comments;

§ Address.

To edit each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete measurement unit

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 37 - Updates information of the employee
profile.

NMFIELD01 X TEXT 255 User's reg. code #.

NMFIELD02 TEXT 255 ID # of educational level

Educational level status;

1 - C omplete;
NMFIELD3 TEXT 255 2 - Unfinished;

* Mandatory when the educational level is

changed.

Integration guide — SE Suite 2.0

 Integration via database 43

NMFIELD4 TEXT 255 Birth date.

NMFIELD05 TEXT 255 Hire date.

NMFIELD06 TEXT 255 Termination date.

DSFIELD01 TEXT 4000 Address.

DSFIELD02 TEXT 4000 C omments.

The values accepted for the import of dates must follow one of the following standards:

§ YYYY-MM-DD

§ DD/MM/YYYY

Example of insertion/editing/deletion of a measurement unit:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, DSFIELD01, DSFIELD02) VALUES
(1, 153, 1, 37, '9902', 'N02', 2, '23/12/1995', '03/04/2017', '31/12/2030', 'Rua
Fulano Nº 34' , 'Comments');

Integration guide — SE Suite 2.0

 Integration via database 44

4.6.2.11 - ADMMEA - Import of measurement units

This import template enables to insert/edit/delete:

§ Data of a measurement unit;

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete measurement unit

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

15 - Insert measurement unit. If it exists,

FGOPTION X NUMERIC 2
edits it.

16 - Delete measurement unit.

Measurement unit ID # (for deletion, only

NMFIELD01 X TEXT 255
this field is required).

NMFIELD02 X TEXT 255 Measurement unit name.

Associate the measurement unit with the

component. Separate the component
NMFIELD3 X TEXT 255
codes with “;”.

Example:109;107.

Example of insertion/editing/deletion of a measurement unit:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (1, 1, 15, 153, 'm', 'Meter');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

Integration guide — SE Suite 2.0

 Integration via database 45

NMFIELD02) VALUES (2, 1, 15, 153, 'm', 'meter');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (3, 1, 16, 153, 'm');

Integration guide — SE Suite 2.0

 Integration via database 46

4.6.2.12 - ADMPOS - Position data import

This import template enables to insert/edit:

§ Data of a position;

To insert each of these items, it is necessary to follow the standard documented below.

Insert position

Column Required Type Precision Description

Sequential code - Identifies an item to be imported into SE

C DINTERFAC E X NUMERIC 10
Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be performed to:

C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
7 - Insert position.

NMFIELD01 X TEXT 255 Position ID #.

NMFIELD02 X TEXT 255 Position name.

Example of position insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (14, 1, 7, 153, 'prog', 'Programmer');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (15, 1, 7, 153, 'ana', 'Analyst');

Integration guide — SE Suite 2.0

 Integration via database 47

Delete position

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
8 - Delete position.

NMFIELD01 X TEXT 255 Position ID #.

Example of position deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (16, 1, 8, 153, 'prog');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (17, 1, 8, 153, 'ana');

Integration guide — SE Suite 2.0

 Integration via database 48

4.6.2.13 - ADMTEAM - Team import

This import template enables to insert/edit/delete:

§ Data of teams;

§ Associate teams with departments, users, and positions;

§ Associate teams with components.

To insert each of these items, it is necessary to follow the standard documented below:

Insert/Edit/Delete teams

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

153 - C ode of component SE Administration.

C ode of the operation to be performed:

31 – Insert team;
FGOPTION X NUMERIC 2
32 – Edit team;

33 – Delete team.

NMFIELD01 X TEXT 255 Team ID # (required field for deletion).

NMFIELD02 X TEXT 255 Team name.

New ID # of the team, if you wish to edit it. If

NMFIELD03 X TEXT 255 the ID # continues the same, enter the current
team ID # (required field only for editing).

C reate team with:

1 – Departments;
NMFIELD04 X TEXT 255
2 – Users;

3 – Positions.

ID # of the (departments, users, positions) that

NMFIELD05 X TEXT 255 will be associated (separated by “,”). Example:
“User1”, “User2”, “User3”.

Integration guide — SE Suite 2.0

 Integration via database 49

C ode of the components this team will be

NMFIELD06 X TEXT 255
associated with.

Example of team insertion/editing/deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD04, NMFIELD05, NMFIELD06) VALUES (1, 1, 31, 153, 'DEV',
'Development', 2, '0203,0127', '109,153,107');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06) VALUES (2, 1, 32, 153, 'DEV',
'Development', 'DEVEL', 2, '0203,0127', '109,153,107');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (3, 1, 33, 153, 'DEVEL');

Integration guide — SE Suite 2.0

 Integration via database 50

4.6.2.14 - ADMTEAMASSOC - Associates a department,

position, or user with a team

This import template enables to insert/delete:

§ Association between a team and a department, position, or user

To insert each of these items, it is necessary to follow the standard documented below:

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

153 - C ode of component SE Administration.

C ode of the operation to be performed:

34 – Associate (department, user, position) with

FGOPTION X NUMERIC 2
a team;

35 – Remove existing association.

NMFIELD01 X TEXT 255 Team ID # (required field for deletion).

C reate team with:

1 – Departments;

NMFIELD02 X TEXT 255 2 – Users;

3 – Positions.

(required field for deletion)

ID # of the (departments, users, positions) that

will be associated (separated by “,”). Example:
NMFIELD03 X TEXT 255
“User1”, “User2”, “User3”.

(required field for deletion)

Integration guide — SE Suite 2.0

 Integration via database 51

Example of association insertion and deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (16, 1, 34, 153, 'DES', '1', '05,Board,03,02')

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (16, 1, 35, 153, 'DEV', 2, '0203')

Integration guide — SE Suite 2.0

 Integration via database 52

4.6.2.15 - ADMUSR - User data import

This import template enables to insert/edit:

§ Data of a user;

§ Relationship between User, Department, and Position;

§ Relationship between User and Access group.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit user

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

153 - C ode of component SE Administration.

C ode of the operation to be performed:

1 - Insert user. If it exists, edits it;

FGOPTION X NUMERIC 2 2 - Insert user. If it exists, returns an error;

3 - Edit user. If it does not exist, returns an

error.

NMFIELD01 X TEXT 255 Name used by the user to log into the system.

NMFIELD02 X TEXT 255 User ID number

NMFIELD03 X TEXT 255 User name.

System language for the user:

1 - English;

2 - Portuguese (Brazil);

NMFIELD04 TEXT 255 3 - Spanish;

X
4 - Portuguese (Portugal);

5 - German;

6 - French;

Integration guide — SE Suite 2.0

 Integration via database 53

7 - Romanian.

NMFIELD05 X TEXT 255 User password.

NMFIELD06 TEXT 255 User countersign.

Maximum number of simultaneous user

NMFIELD07 TEXT 255
connections.

NMFIELD08 TEXT 255 User phone #.

NMFIELD09 TEXT 255 Leader ID #.

NMFIELD10 TEXT 255 User unique ID # in the domain controller.

NMFIELD11 TEXT 255 Enabled user (1 - Enabled, 0 - Disabled).

NMFIELD12 TEXT 255 Blocked user (1 - Blocked, 0 - Unblocked).

FGNOTIC E (1 - Receive news from SotfExpert, 0

NMFIELD13 TEXT 255
- Do not receive news from SotfExpert).

NMFIELD14 TEXT 255 FGUSERTYPE ().

ID # of the connection with the domain

controller where the user was imported from
NMFIELD15 TEXT 255
(Used in the user data synchronization with the
Domain controller).

DSFIELD01 TEXT 4000 User e-mail address.

DSFIELD02 TEXT 4000 User description.

Example of user insertion/editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, DSFIELD01, DSFIELD02) VALUES (1, 1, 2, 153, 'Joe', 'Joe', 'Joe Carl',
'2', '111111', '111111', '3', '2505-9984', 'Jim', '[email protected]', 'Description of
Joe');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, DSFIELD01, DSFIELD02) VALUES (2, 1, 1, 153, 'Micael', 'Micael', 'Micael
Hansen', '2', 'mic1', 'mic1', '1', '2505-0000', 'Jim', '[email protected]',
'Description of Micael');

Integration guide — SE Suite 2.0

 Integration via database 54

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, DSFIELD01, DSFIELD02) VALUES (3, 1, 3, 153, 'Half', 'Half', 'Half Toel',
'2', 'halftoel', '111111', '1', '2909-9909', 'Micael', '[email protected]',
'Description of Half');

Insert/delete relationship between user, department, and position

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

4 - Insert relationship between user,

FGOPTION X NUMERIC 2 department, and position;

6 - Delete relationship between user,

department, and position.

NMFIELD01 X TEXT 255 User ID number

NMFIELD02 X TEXT 255 Department ID #.

NMFIELD03 X TEXT 255 Position ID #.

Default department:

NMFIELD04 X NUMERIC 2 1 - Yes;

2 - No.

Example of insertion/deletion of relationship between user, department, and position:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (4, 1, 4, 153, 'Joe', 'tec', 'ana', 2);

Integration guide — SE Suite 2.0

 Integration via database 55

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (5, 1, 4, 153, 'Micael', 'des', 'prog', 1);

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (6, 1, 4, 153, 'Half', 'tec', 'ana', 2);

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (7, 1, 6, 153, 'Half', 'tec', 'ana', 2);

Insert/delete relationship between user and access group

Column Required Type Precision Description

Sequential code - Identifies an item to

C DINTERFAC E X NUMERIC 10
be imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will

be performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

13 - Insert relationship between user

FGOPTION X NUMERIC 2 and access group;

14 - Delete relationship between user

and access group.

NMFIELD01 X TEXT 255 User ID number

NMFIELD02 X TEXT 255 Access group ID #.

Example of insertion/deletion of relationship between user and access group:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (8, 1, 13, 153, 'Joe', 'Capture - Staff');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (9, 1, 13, 153, 'Micael', 'Capture - View');

Integration guide — SE Suite 2.0

 Integration via database 56

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (10, 1, 13, 153, 'Half', 'Capture - View');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (11, 1, 14, 153, 'Joe', 'Capture - Staff');

Disable user

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
153 - C ode of component SE
Administration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
5 - Disable user.

NMFIELD01 X TEXT 255 User ID number

Example of user deactivation:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (12, 1, 5, 153, 'Joe');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (13, 1, 5, 153, 'Micael');

Integration guide — SE Suite 2.0

 Integration via database 57

4.6.2.16 - ADMUSRCOMP - Full import of user data

This import template enables to insert/edit:

§ Data of a user;

§ Relationship between User, Department, and Position;

§ Relationship between User and Access group.

§ Relationship between User and Team.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit user

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

153 - C ode of component SE Administration.

C ode of the operation to be performed:

20 - Inserts user; if it exists, it edits the existing

user. Department, position, teams and groups
FGOPTION X NUMERIC 2 are added;

21 - Inserts user; if it exists, it edits the existing

user. Department, position, teams and access
groups are substituted;

NMFIELD01 X TEXT 255 Name used by the user to log into the system.

NMFIELD02 X TEXT 255 User ID number

NMFIELD03 X TEXT 255 User name.

System language for the user:

1 - English;
NMFIELD04 TEXT 255
X 2 - Portuguese (Brazil);

3 - Spanish;

Integration guide — SE Suite 2.0

 Integration via database 58

4 - Portuguese (Portugal);

5 - German;

6 - French;

7 - Romanian.

NMFIELD05 X TEXT 255 User password.

NMFIELD06 TEXT 255 User countersign.

Maximum number of simultaneous user

NMFIELD07 TEXT 255
connections.

NMFIELD08 TEXT 255 User phone #.

NMFIELD09 TEXT 255 Leader ID #.

NMFIELD10 TEXT 255 User unique ID # in the domain controller.

NMFIELD11 TEXT 255 Enabled user (1 - Enabled, 0 - Disabled).

NMFIELD12 TEXT 255 Blocked user (1 - Blocked, 0 - Unblocked).

FGNOTIC E (1 - Receive news from SotfExpert, 0

NMFIELD13 TEXT 255
- Do not receive news from SotfExpert).

NMFIELD14 TEXT 255 FGUSERTYPE ().

ID # of the connection with the domain

controller where the user was imported from
NMFIELD15 TEXT 255
(Used in the user data synchronization with the
Domain controller).

NMFIELD16 TEXT 255 User e-mail address.

List of department id # and position id #. For

each item that represents the department and
position, must be represented as: 'id #-
DSFIELD01 TEXT 4000
department#id #-position'. In case of more than
one item such as department and position, a
comma must be used to separate it.

List of team id # separated by commas if you

DSFIELD02 TEXT 4000
wish to add more than one team.

List of access groups id # separated by commas

DSFIELD03 TEXT 4000
if you wish to add more than one.

Integration guide — SE Suite 2.0

 Integration via database 59

Example of user insertion/editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, DSFIELD01, DSFIELD02, DSFIELD03) VALUES (1, 1, 2, 153, 'Joe', 'Joe', 'Joe
Carl', '2', '111111', '111111', '3', '2505-9984', 'Jim', '[email protected]',
'department-cod+position-cod,department-cod-2+position-cod-2', 'team-cod-1, team-
cod-2', 'access-gp-1,access-gp-2');

Integration guide — SE Suite 2.0

 Integration via database 60

4.6.3 - Storeroom

This section contains the following topics:

§ STMADATTRIB - Attribute import

§ STMADATTRIBVALUE - Attribute value import

§ STMDELINPUTEVENT - Input event deletion

§ STMDELOUTPUTEVENT - Output event deletion

§ STMDELSTORAGEPLACE - Storage place deletion

§ STMDELSTORE - Storeroom deletion

§ STMDELSTOREOBJ - Storeroom object deletion

§ STMEVENTATTRIB - Import of association of event attributes

§ STMINPUTEVENT - Input event import

§ STMINPUTOBJECT - Import of input/output event objects

§ STMOUTPUTEVENT - Output event import

§ STMSTORAGEPLACE - Storage place import

§ STMSTORE - Storeroom import

§ STMSTOREATTRIB - Import of storeroom attribute association

§ STMSTOREOBJECT - Import of storeroom objects

Integration guide — SE Suite 2.0

 Integration via database 61

4.6.3.1 - STMADATTRIB - Attribute import

This import template makes it possible to insert:

§ Data of an attribute.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 - C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
96 - Insert a new attribute

NMFIELD01 X TEXT 255 Attribute ID #.

NMFIELD02 X TEXT 255 Attribute name.

NMFIELD03 X TEXT 255 User ID #.

Attribute type:

1 - List of values;
NMFIELD04 TEXT 255
X 2 - Non-discrete;

3 - External.

Attribute data type.

List of values:

1 - Text;

2 - Numeric;
NMFIELD05 X TEXT 255
3 - Date;

5 - C urrency.

Non-discrete:

1 - Text;

Integration guide — SE Suite 2.0

 Integration via database 62

2 - Numeric;

3 - Date;

4 - Memo;

5 - C urrency.

External:

1 - Text.

Selection mode. The 'List of Values' and

'External' attribute types must inform the
'Selection Mode'. Accepted values:

1 - Zoom;

NMFIELD06 TEXT 255 2 - C ombo.

The 'List of Values' attribute type can inform

whether the attribute will be 'Multivalued'.

Accepted values:

1 - Multivalued.

NMFIELD07 TEXT 255 Multivalued.

Example of attribute insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION,NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07)VALUES (01, 180, 1,
96, 'ENDDATA', 'Data List', 'Andy',’1’,’3’,’2’);

Integration guide — SE Suite 2.0

 Integration via database 63

4.6.3.2 - STMADATTRIBVALUE - Attribute value import

This import template makes it possible to insert:

§ Data of an attribute value.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
95 – Insert a new attribute value

NMFIELD01 X TEXT 255 Attribute ID #.

Attribute value.

Required information if the attribute type is List

NMFIELD02 X TEXT 255
of values. Non-discrete type attributes will not
be accepted for the import of values.

Use as default.

1 - The value of the attribute will be the default

NMFIELD03 X TEXT 255 for the attribute;

2 - The value of the attribute will not be the

default for the attribute.

NMFIELD04 TEXT 255 User ID #.

X

Server (name or IP address of the external

NMFIELD05 TEXT 255
attribute database).

NMFIELD06 TEXT 255 Alias/Database path (external attribute).

Integration guide — SE Suite 2.0

 Integration via database 64

NMFIELD07 TEXT 255 Database user (external attribute).

NMFIELD08 TEXT 255 Password (external attribute).

DB type:

1 – ITERBASE;

2 – MSSQL;

3 – MSSQL (ODBC );

4 – ORAC LE < 8.05;

5 – ORAC LE 8/9 (SERVIC E NAME);

NMFIELD09 TEXT 255 6 – ORAC LE 8/9 (SID);

7 – ORAC LE (ODBC );

8 – DB2 (ODBC );

9 – INFORMIX;

10 – ORAC LE 8/9 (TNS NAME);

11 – MySQL;

12 – POSTGRESQL.

SQL (Select that will search for the external

NMFIELD10 TEXT 255
attribute field).

Field.

NMFIELD11 TEXT 255 Standards to enter date type data:

§ yyyy-mm-dd.

Example of insertion of attribute values:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11) VALUES (01, 180, 1, 95, 'ENDDATA', 'Data List',
'1', 'DES076', 'Andy', 'BDORACLE',’th01’,’111111’,’ORACLE’,’’ ,’’);

Integration guide — SE Suite 2.0

 Integration via database 65

4.6.3.3 - STMDELINPUTEVENT - Input event deletion

This import template enables to delete:

§ An input event.

To insert each of these items, it is necessary to follow the standard documented below.

Deletion

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
8 – Delete an input event.

NMFIELD01 X TEXT 255 Input event ID #.

Example of Deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01)

VALUES (1, 180, 1, 8, 'Eve001');

Integration guide — SE Suite 2.0

 Integration via database 66

4.6.3.4 - STMDELOUTPUTEVENT - Output event deletion

This import template enables to delete:

§ An output event.

To insert each of these items, it is necessary to follow the standard documented below.

Deletion

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
10 – Delete an output event.

NMFIELD01 X TEXT 255 Output event ID #.

Example of Deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01)

VALUES (1, 180, 1, 10, 'Eve004');

Integration guide — SE Suite 2.0

 Integration via database 67

4.6.3.5 - STMDELSTORAGEPLACE - Storage place deletion

This import template enables to delete:

§ A saved storage place.

To insert each of these items, it is necessary to follow the standard documented below.

Deletion

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
6 – Delete a storage place.

NMFIELD01 X TEXT 255 Storage place ID #.

Example of Deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01)

VALUES (1, 180, 1, 6, 'LC005/1');

Integration guide — SE Suite 2.0

 Integration via database 68

4.6.3.6 - STMDELSTORE - Storeroom deletion

This import template enables to delete:

§ A saved storeroom.

To insert each of these items, it is necessary to follow the standard documented below.

Deletion

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
2 – Delete a storeroom.

NMFIELD01 X TEXT 255 Storeroom ID #.

Example of Deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01)

VALUES (1, 180, 1, 2, 'STO005');

Integration guide — SE Suite 2.0

 Integration via database 69

4.6.3.7 - STMDELSTOREOBJ - Storeroom object deletion

This import template enables to delete:

§ Storeroom objects.

To insert each of these items, it is necessary to follow the standard documented below.

Deletion

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
4 – Deletion of a storeroom object.

NMFIELD01 X TEXT 255 Storeroom ID #.

NMFIELD02 X TEXT 255 Object ID #.

Example of Storeroom object deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02)
VALUES (1, 180, 1, 1, 'STO005', 'Res001');

Integration guide — SE Suite 2.0

 Integration via database 70

4.6.3.8 - STMEVENTATTRIB - Import of association of event

attributes

This import template makes it possible to insert:

§ Data of an event attribute association.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
12 – Inserts a new event attribute association.

NMFIELD01 X TEXT 255 Event ID #.

NMFIELD02 X TEXT 255 Attribute ID #.

Attribute value.

Standards to enter date type data:

NMFIELD03 X TEXT 255
§ dd/mm/yyyy;

§ yyyy-mm-dd.

Revision ID #.

Required information if the component needs

NMFIELD04 TEXT 255
X the revision code in the specific table of the
attribute.

If the entered value is 1, the interface will

verify whether the attribute value already
NMFIELD10 TEXT 255
belongs to the list of values; if it does not exist,
it will be added.

Integration guide — SE Suite 2.0

 Integration via database 71

Attribute value.
DSFIELD01 TEXT 4000 Mandatory information if the type of the
attribute value is MEMO.

Example of insertion of attribute values:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04)
VALUES (1, 180, 1, 12, 'STO005','ENDDATA', '25/12/2014', '00');

Integration guide — SE Suite 2.0

 Integration via database 72

4.6.3.9 - STMINPUTEVENT - Input event import

This import template makes it possible to insert:

§ Data of an input event.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
7 – Add a new input event.

NMFIELD01 X TEXT 255 Event ID #.

NMFIELD02 X TEXT 255 Event name.

Requester type:

1 – Department;

NMFIELD03 X TEXT 255 2 – User;

3 – Supplier;

4 – Process activity.

NMFIELD04 TEXT 255 Issuer ID #, according to the previous type

X

Activity ID #
NMFIELD05 TEXT 255 Note: Required only when the requester type is
process activity.

NMFIELD06 TEXT 255 Source responsibility name.

NMFIELD07 TEXT 255 Source date.

Integration guide — SE Suite 2.0

 Integration via database 73

NMFIELD08 TEXT 255 Storeroom ID #.

NMFIELD09 TEXT 255 Destination responsible person.

NMFIELD10 TEXT 255 Destination date

NMFIELD11 TEXT 255 Approval route ID #.

DSFIELD01 TEXT 4000 Event description.

Example of Insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, DSFIELD01)
VALUES (1, 180, 1, 7, 'Eve001', 'Eve001', 2, 'Andy', null, null, 'STO005',
'StoWaste', null, null, null, 'Waste transfer to storage.');

Integration guide — SE Suite 2.0

 Integration via database 74

4.6.3.10 - STMINPUTOBJECT - Import of input/output event

objects

This import template makes it possible to insert:

§ Data of the objects of an input or output event

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 11 – Insert a new object of an input or output
event.

NMFIELD01 X TEXT 255 Event ID #.

NMFIELD02 X TEXT 255 Object ID #.

NMFIELD03 X TEXT 255 Storage place ID #.

NMFIELD04 TEXT 255 Quantity.

X

NMFIELD05 TEXT 255 Lot number.

NMFIELD06 TEXT 255 Serial number.

NMFIELD07 NUMERIC 10 Unit cost (only for input event).

Integration guide — SE Suite 2.0

 Integration via database 75

Example of Insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04)
VALUES (1, 180, 1, 11, 'Mov001', 'AS001241', 'LA005/01', 2540);

Integration guide — SE Suite 2.0

 Integration via database 76

4.6.3.11 - STMOUTPUTEVENT - Output event import

This import template makes it possible to insert:

§ Data of an output event.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
9 – Insert a new output event.

NMFIELD01 X TEXT 255 Event ID #.

NMFIELD02 X TEXT 255 Event name.

NMFIELD03 X TEXT 255 Storeroom ID #.

NMFIELD04 TEXT 255 Source responsibility name.

NMFIELD05 TEXT 255 Source date.

Addressee type:

1 – Department;

NMFIELD06 X TEXT 255 2 – User;

3 – Supplier;

4 – Delete.

Addressee/disposition, according to the

previous type:
NMFIELD07 TEXT 255
Department: department id #;

User: user id #;

Integration guide — SE Suite 2.0

 Integration via database 77

Supplier: supplier id#;

Delete - Disposal/Treatment:
disposal/treatment ID #.

NMFIELD08 TEXT 255 Destination responsible person.

NMFIELD09 TEXT 255 Destination date.

NMFIELD10 TEXT 255 Approval route ID #.

DSFIELD01 TEXT 4000 Event description.

Example of Insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, DSFIELD01)
VALUES (1, 180, 1, 9, 'Eve004', 'Eve004', 'STO005', 'Andy', '', 1, 'Test event.');

Integration guide — SE Suite 2.0

 Integration via database 78

4.6.3.12 - STMSTORAGEPLACE - Storage place import

This import template makes it possible to insert:

§ Storage place data.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
5 – Insert a new storage place

NMFIELD01 X TEXT 255 Storeroom ID #.

NMFIELD02 X TEXT 255 Storage place ID #.

NMFIELD03 X TEXT 255 Storage place name.

Place type:

NMFIELD04 TEXT 255 1 – Storage place;

X
2 – Repository.

NMFIELD05 TEXT 255 Upper storage place ID #.

C ontrols the capacity of repositories (Not valid

for repository type):
NMFIELD06 TEXT 255
1 – Yes;

2 or NULL – No.

Maximum number of repositories.

NMFIELD07 TEXT 255
Note: Required if the previous field is 1.

Integration guide — SE Suite 2.0

 Integration via database 79

Example of Insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (1, 180, 1, 5, 'STO005', 'LC005/1',
'Warehouse 005/1', 1);

Integration guide — SE Suite 2.0

 Integration via database 80

4.6.3.13 - STMSTORE - Storeroom import

This import template makes it possible to insert:

§ Data of a storeroom.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
1 – Insert a new storeroom

NMFIELD01 X TEXT 255 Storeroom ID #.

NMFIELD02 X TEXT 255 Storeroom name.

NMFIELD03 X TEXT 255 Storeroom type ID #.

Storeroom object:

2 – Waste;
NMFIELD04 TEXT 255
X 3 – PDM;

4 – Supply.

NMFIELD05 X TEXT 255 Responsible team ID #.

NMFIELD06 TEXT 255 Upper level storeroom ID #.

NMFIELD07 TEXT 255 Event configuration ID #.

Storeroom owner type:

NMFIELD08 X TEXT 255 1 – Internal;

2 – C ustomer;

Integration guide — SE Suite 2.0

 Integration via database 81

3 – Supplier.

Storeroom owner ID #.

If internal: Department ID #.

If customer: C ustomer ID #.
NMFIELD09 TEXT 255
If supplier: Supplier ID#.

Note: If not entered, must follow the owner

type.

DSFIELD01 TEXT 4000 Storeroom description.

Example of Insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, DSFIELD01) VALUES (1, 180, 1, 1, 'STO005', 'Storeroom 005', 'StoWaste',
2, 'RPR', null, '01', '013', 'Covered waste storeroom.');

Integration guide — SE Suite 2.0

 Integration via database 82

4.6.3.14 - STMSTOREATTRIB - Import of storeroom attribute

association

This import template makes it possible to insert:

§ Data of an association of storeroom attribute.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 94 – Inserts a new storeroom attribute
association.

NMFIELD01 X TEXT 255 Storeroom ID #.

NMFIELD02 X TEXT 255 Attribute ID #.

Attribute value.

Standards to enter date type data:

NMFIELD03 X TEXT 255
§ dd/mm/yyyy;

§ yyyy-mm-dd.

Revision ID #.

Required information if the component needs

NMFIELD04 TEXT 255
X the revision code in the specific table of the
attribute.

If the entered value is 1, the interface will

verify whether the attribute value already
NMFIELD10 TEXT 255
belongs to the list of values; if it does not exist,
it will be added.

Integration guide — SE Suite 2.0

 Integration via database 83

Attribute value.
DSFIELD01 TEXT 4000 Mandatory information if the type of the
attribute value is MEMO.

Example of insertion of attribute values:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (1, 180, 1, 94, 'STO005','ENDDATA',
'25/12/2014', '00');

Integration guide — SE Suite 2.0

 Integration via database 84

4.6.3.15 - STMSTOREOBJECT - Import of storeroom objects

This import template makes it possible to insert:

§ New storeroom objects.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

180 – C ode of component SE Storeroom.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
3 – Import of a new storeroom object.

NMFIELD01 X TEXT 255 Storeroom ID #.

NMFIELD02 X TEXT 255 Object ID #

C ontrol ideal amount:

NMFIELD03 TEXT 255 1 – Yes;

2 or NULL – No.

Ideal quantity (required if the value of the

NMFIELD04 TEXT 255
previous field is 1).

Notify when the stock is below the ideal

quantity:
NMFIELD05 TEXT 255
1 – Yes;

2 or NULL – No.

C ontrol reorder point:

NMFIELD06 TEXT 255 1 – Yes;

2 or NULL – No.

NMFIELD07 TEXT 255 Reorder point quantity.

Integration guide — SE Suite 2.0

 Integration via database 85

Notify when the stock is below the reorder

point:
NMFIELD08 TEXT 255
1 – Yes;

2 or NULL – No.

Restrict storage place:

NMFIELD09 TEXT 255 1 – Yes;

2 or NULL – No.

C ontrol maximum capacity:

NMFIELD10 TEXT 255 1 – Yes;

2 or NULL – No.

Example of storage object insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10)
VALUES (1, 180, 1, 1, 'STO005', 'Was001', 1, '200', 2, null, '150', 2, null, 1);

Integration guide — SE Suite 2.0

 Integration via database 86

4.6.4 - Asset

This section contains the following topics:

§ ASTAST - Import of assets

§ ASTASTATT - Import of asset attributes

§ ASTCONFSITE - Storage place import

§ ASTOEE - Insertion of Parameter data to calculate OEE

§ ASTPLANACT - Activity plan import

§ ASTSECU - Asset type security import

§ ASTSITE - Asset location import

§ ASTSTATE - Asset condition import

§ ASTSTATUS - Asset status import

§ ASTSTRC - Asset structure import

§ ASTTYPE - Import of asset types

Integration guide — SE Suite 2.0

 Integration via database 87

4.6.4.1 - ASTAST - Import of assets

This import template enables to insert/edit/delete:

§ Data of an asset.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete asset

Column Required Type Precision Description

Sequential code - Identifies an item

C DINTERFAC E X NUMERIC 10
to be imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration

will be performed to:
C DISOSYSTEM X NUMERIC 10
109 - C ode of component SE
Asset.

C ode of the operation to be

performed:
FGOPTION X NUMERIC 2 1 - Insert asset. If it exists,
edits it;
2 - Delete asset.

Asset ID # (for deletion, only this

NMFIELD01 X TEXT 255
field is required).

NMFIELD02 X TEXT 255 Asset name.

NMFIELD03 X TEXT 255 Asset type ID #.

NMFIELD04 X TEXT 255 Responsible team ID #.

Asset specification:
1 - Gage;
2 - Equipment;
NMFIELD05 X TEXT 255 4 - Others;
6 - Tooling;
7 – Tools;

11 – C omputer.

NMFIELD06 X TEXT 255 Operation start date.

Integration guide — SE Suite 2.0

 Integration via database 88

NMFIELD07 X TEXT 255 Asset quantity

NMFIELD08 TEXT 255 C avity (required for "Tooling").

NMFIELD09 TEXT 255 Manufacturer (company name).

NMFIELD10 TEXT 255 Serial number.

NMFIELD11 TEXT 255 Template.

NMFIELD12 TEXT 255 C alendar ID #.

NMFIELD13 TEXT 255 Supplier (company name).

NMFIELD14 TEXT 255 Equipment cost

NMFIELD15 TEXT 255 Hourly cost

Asset attributes. Example:

ID
#_of_attribute=value1_of_attribute,v
alue2_of_attribute,value3_of_attribut
DSFIELD01 TEXT 4000
e.
Note: for attributes with numeric
value, the decimal separator should
be the ‘.’ (dot).

DSFIELD02 TEXT 4000 Description.

DSFIELD03 TEXT 4000 C haracteristics.

DSFIELD04 TEXT 4000 C omments.

Example of asset insertion/editing/deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM,

NMFIELD01,NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06 , NMFIELD07,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD13, NMFIELD14, NMFIELD15, DSFIELD02,
DSFIELD03, DSFIELD04) VALUES (1, 1, 1, 109, 'CAL000001', 'Caliper 0 - 150mm', 'Dig.
Caliper','Maintenance equipment', '1', '01/01/2009', '1', 'CAL001', 'Serial number',
'Model', 'Supplier', '100', '10', 'Description', 'Characteristics', 'Comments');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM,

NMFIELD01,NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06 , NMFIELD07,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD13, NMFIELD14, NMFIELD15, DSFIELD02,
DSFIELD03, DSFIELD04) VALUES (1, 1, 1, 109, 'CAL000001', 'Caliper 0 - 150mm', 'Dig.
Caliper','Team', '1', '01/01/2009', '1', 'CAL001', 'Serial number', 'Model',
'Supplier', '100', '10', 'Descr', 'Caract', 'Comm');

Integration guide — SE Suite 2.0

 Integration via database 89

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (3, 1, 2, 109, 'CAL000001');

Integration guide — SE Suite 2.0

 Integration via database 90

4.6.4.2 - ASTASTATT - Import of asset attributes

This import template enables to update:

§ Values of asset attributes.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

109 - C ode of component SE Asset.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 13 - Inserts the value for an attribute. If it
exists, edits it.

NMFIELD01 X TEXT 255 Asset ID #.

NMFIELD02 X TEXT 255 Attribute ID #.

Attribute value.

Standards to enter date type data:

NMFIELD03 X TEXT 255
· dd/mm/yyyy;

· yyyy-mm-dd.

NMFIELD04 TEXT 255 Revision ID # of the asset.

If the value 1 is entered, the interface will

verify whether the attribute value already
NMFIELD10 TEXT 255
belongs to the list of values. If it does not exist,
it will be added.

Attribute value. Mandatory information if the

DSFIELD01 TEXT 4000
type of the attribute value is MEMO.

Integration guide — SE Suite 2.0

 Integration via database 91

Example of the function to edit the value of the asset attribute:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (15, 109, 1, 13, ‘AT000001’, ‘Brand’,
‘Traditional’, ‘00’);

Integration guide — SE Suite 2.0

 Integration via database 92

4.6.4.3 - ASTCONFSITE - Storage place import

This import template enables to insert, update, or delete:

§ Storage place.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

109 - C ode of component SE Asset.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 14 – Insert storage place. If it exists, edits it;

15 – Delete storage place.

Storage place ID # (for deletion, only this field

NMFIELD01 X TEXT 255
is required).

NMFIELD02 X TEXT 255 Storage place name.

NMFIELD03 TEXT 255 Upper storage place type (ID #).

Active record

NMFIELD04 X TEXT 255 1 – Yes;

2 – No.

DSFIELD01 TEXT 4000 Description.

Example of the function to insert a storage place:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, DSFIELD01) VALUES (1, 109, 1, 14, ‘1AP1’, ‘1st
floor’, ‘P1’, 1, NULL);

Integration guide — SE Suite 2.0

 Integration via database 93

4.6.4.4 - ASTOEE - Insertion of Parameter data to calculate

OEE

This import template enables to add:

§ Parameter data to calculate OEE

To insert the data, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be imported into SE

C DINTERFAC E X NUMERIC 10
Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be performed to:

C DISOSYSTEM X NUMERIC 10
109 – C ode of component SE Asset

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
20 – Add.

NMFIELD01 X TEXT 255 Asset ID #

NMFIELD02 X TEXT 255 Start date.

NMFIELD04 X TEXT 255 End date

NMFIELD06 X TEXT 255 Quality parts

NMFIELD07 X TEXT 255 Total parts

NMFIELD08 X TEXT 255 Amount produced

NMFIELD09 X TEXT 255 Planned quantity

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD04, NMFIELD06, NMFIELD07, NMFIELD08, NMFIELD09) VALUES (1, 1, 20,
109, 'CMP-001', '31/01/2015', '31/01/2015', '100', '110', '110', '100');

Integration guide — SE Suite 2.0

 Integration via database 94

4.6.4.5 - ASTPLANACT - Activity plan import

This import template enables to insert/edit:

§ Data of a Verification/Maintenance preventive/Calibration plan

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit

Column Required Type Precision Description

Sequential code - Identifies an item to be imported into SE

C DINTERFAC E X NUMERIC 10
Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be performed to:

C DISOSYSTEM X NUMERIC 10
109 – C ode of component SE Asset

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 21 – Add activity plan;

22 – Edit activity plan.

Plan type:

1 – Verification;
NMFIELD01 X¹ TEXT 255
2 – Preventive maintenance;

3 – C alibration.

NMFIELD02 X TEXT 255 Plan ID #

NMFIELD03 X¹ TEXT 255 Plan name

NMFIELD04 X¹ TEXT 255 Standard activity ID #

Plan configuration:

NMFIELD05 X¹ TEXT 255 1 – Inherit activity data;

2 – C opy activity data.

Asset ID #. For multiple assets separate the identifiers with

NMFIELD06 X¹ TEXT 255 semicolons.

E.g.: IDATIVO01;IDATIVO02;IDATIVO03

NMFIELD07 X¹ TEXT 255 Responsible team ID # for plan

NMFIELD08 X² TEXT 255 Responsible team ID # for planning

Integration guide — SE Suite 2.0

 Integration via database 95

NMFIELD09 X² TEXT 255 Responsible team ID # for execution

Date-based frequency:

NMFIELD10 TEXT 255 1 – Enable;

2 – Disable.

Frequency type:

1 – Execution date;
NMFIELD11 X³ TEXT 255
2 – First use;

3 – Usage time.

NMFIELD12 X³ TEXT 255 Frequency

Frequency unit:

1 – Day(s);

2 – Week(s);
NMFIELD13 X³ TEXT 255
3 – Month(s);

4 – Year(s);

5 – Working day(s).

Date visualization:

NMFIELD14 X³ TEXT 255 1 – Month/Day/Year;

2 – Month/Year.

NMFIELD15 X³ TEXT 255 Date of the next execution (format Y-m-d)

NMFIELD16 TEXT 255 C alendar ID #.

Frequency based on asset meter:

NMFIELD17 TEXT 255 1 – Enable;

2 – Disable.

NMFIELD18 x4 TEXT 255 Frequency

NMFIELD19 x4 TEXT 255 Anticipation

NMFIELD20 x4 TEXT 255 Next execution

C reate activity automatically:

NMFIELD21 TEXT 255 1 – Enable;

2 – Disable.

Activity step created automatically:

NMFIELD22 x5 TEXT 255 1 – Planning;

2 – To be started.

Number of days that the automatic activity will be created

NMFIELD23 x5 TEXT 255
previously

Integration guide — SE Suite 2.0

 Integration via database 96

§ X¹: Required when inserting.

§ X²: Required when inserting if the plan configuration is a copy.

§ X³: Required if the date-based frequency is enabled.

§ X4: Required if the meter-based frequency is enabled.

§ X5: Required if the create activity automatically option is enabled.

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM,

NMFIELD01,NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07,
NMFIELD10, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD14, NMFIELD15) VALUES (1, 1, 21,
109, 1, 'IDPLAN01', 'NMPLAN01', 'IDACTMODEL', 1, 'ATIVO01', 'EQ001', 1, 1, 7, 1, 1,
'2017-07-03');

Example of editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM,NMFIELD02,

NMFIELD03, NMFIELD04, NMFIELD06, NMFIELD07) VALUES (1, 1, 22, 109, 'IDPLAN01',
'NMPLAN-EDITADO', 'IDACTMODEL-EDITADA', 'ATIVO01', 'EQ001-EDITADA');

Integration guide — SE Suite 2.0

 Integration via database 97

4.6.4.6 - ASTSECU - Asset type security import

This import template enables to insert/edit/delete:

§ Security data of the asset type.

To insert each of these items, it is necessary to follow the standard documented below.

Insert security data of the asset type

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

109 - C ode of component SE Asset.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 12 - Insert security control for the asset
type.

NMFIELD01 X TEXT 255 Asset type ID #.

Permission group type:

1 - Team;

2 - Department;

NMFIELD02 X TEXT 255 3 - Department/Position;

4 - Position;

5 - User;

6 - All.

C ontrol to add:

NMFIELD03 X TEXT 255 1 - Yes;

2 - No.

C ontrol to edit:

NMFIELD04 TEXT 255 1 - Yes;

X
2 - No.

Integration guide — SE Suite 2.0

 Integration via database 98

C ontrol to delete:

NMFIELD05 X TEXT 255 1 - Yes;

2 - No.

Security data control:

NMFIELD06 X TEXT 255 1 - Yes;

2 - No.

C ontrol to list:

NMFIELD07 X TEXT 255 1 - Yes;

2 - No.

C ontrol to view:

NMFIELD08 X TEXT 255 1 - Yes;

2 - No.

Permission:

NMFIELD09 X TEXT 255 1 - Allow;

2 - Deny.

Access type ID #.

Example: If the type is by user, it will be

NMFIELD10 X¹ TEXT 255
the user ID. If the type is by department,
it will be the department ID #.

Position ID #. This field will only be used if

the type is by department and position.
NMFIELD11 X² TEXT 255 That way, the department will go in the
NMFIELD10 field and the position, in this
one.

X 1 - Required when NMFIELD02 is different from 6;

X² - Required when NMFIELD02 is equal to 4.

Example of insertion of security for asset types:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11) VALUES (1, 1, 12, 109, 'Cal', '1', '1', '1', '1',
'1', '1', '1', '1', 'Team 01', '');

Integration guide — SE Suite 2.0

 Integration via database 99

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11) VALUES (2, 1, 12, 109, 'Cal', '4', '1', '1', '1',
'1', '1', '1', '1', 'Department 01', 'Position 01');

Integration guide — SE Suite 2.0

 Integration via database 100

4.6.4.7 - ASTSITE - Asset location import

This import template enables to insert/delete:

§ Location data of an asset.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/delete asset location

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

109 - C ode of component SE Asset.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 5 - Insert location of an asset;

6 - Delete location of an asset.

Asset ID # (for deletion, only this field is

NMFIELD01 X TEXT 255
required).

NMFIELD02 X TEXT 255 Date (in the database format).

NMFIELD03 X TEXT 255 Time (hh:mm).

Location type:

1 - Location;
NMFIELD04 TEXT 255
X 2 - User;

3 - Location and user.

Storage place ID #. Required for location

NMFIELD05 X TEXT 255
type 1 or 3.

User ID # (User ID). Required for location

NMFIELD06 TEXT 255
X type 2 or 3.

NMFIELD07 TEXT 255 C omments.

Integration guide — SE Suite 2.0

 Integration via database 101

Example of asset location insertion/deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07) VALUES (1, 1, 5,
109, 'Computer#152', '01/01/2009', '10:00', '1', 'Classroom 01', '', '');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07) VALUES (2, 1, 5,
109, 'Computer#152', '01/01/2009', '11:00', '3', 'Classroom 01', '101010', '');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (3, 1, 6, 109, 'Computer#152');

Integration guide — SE Suite 2.0

 Integration via database 102

4.6.4.8 - ASTSTATE - Asset condition import

This import template enables to insert/delete:

§ Data of the condition of an asset.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/delete asset condition

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

109 - C ode of component SE Asset.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 7 - Insert condition of an asset;

8 - Delete condition of an asset.

Asset ID # (for deletion, only this field is

NMFIELD01 X TEXT 255
required).

NMFIELD02 X TEXT 255 Date (in the database format).

NMFIELD03 X TEXT 255 Time (hh:mm).

NMFIELD04 X TEXT 255 C ondition ID #.

NMFIELD05 TEXT 255 C omments.

Example of insertion/deletion of asset conditions:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 7, 109, 'Computer#152',
'01/01/2009', '10:00', 'New', '');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (2, 1, 7, 109, 'Computer#152',
'01/01/2009', '15:00', 'Broken', '');

Integration guide — SE Suite 2.0

 Integration via database 103

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (3 , 1 , 8 , 109 , 'Computer#152');

Integration guide — SE Suite 2.0

 Integration via database 104

4.6.4.9 - ASTSTATUS - Asset status import

This import template enables to edit:

§ Asset status data;

To insert each of these items, it is necessary to follow the standard documented below.

Enable/disable assets

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

109 – C ode of component SE Asset.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
9 - Enable / Disable asset.

NMFIELD01 X TEXT 255 Asset ID #.

1 - Enable asset;
NMFIELD02 X TEXT 255
2 - Disable asset.

When disabling, cancel the asset

reservations:
NMFIELD03 X TEXT 255
1 - Yes;

2 - No.

NMFIELD04 X TEXT 255 Explanation.

Example of asset enabling/disabling:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (1, 1, 9, 109, 'Computer#152', '2', '1',
'Damaged equipment');

Integration guide — SE Suite 2.0

 Integration via database 105

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (2, 1, 9, 109, 'Computer#152', '1', '',
'Repaired equipment');

Integration guide — SE Suite 2.0

 Integration via database 106

4.6.4.10 - ASTSTRC - Asset structure import

This import template enables to insert/edit/delete:

§ Asset structure data.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete asset structures

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

109 - C ode of component SE Asset.

C ode of the operation to be performed:

3 - Insert asset to the structure. If it

FGOPTION X NUMERIC 2
exists, edits it;

4 - Delete asset in the structure.

NMFIELD01 X TEXT 255 Upper level asset (parent asset) ID #.

Upper level asset (parent asset) revision

NMFIELD02 X TEXT 255
ID #.

NMFIELD03 X TEXT 255 Asset (lower level asset) ID #.

NMFIELD04 X TEXT 255 Asset (lower level asset) revision ID #.

NMFIELD05 X TEXT 255 Quantity used in the structure.

Object specification (C onsidered as 1 by

default):
NMFIELD06 TEXT 255
1 - Asset;

2 - Supply.

Integration guide — SE Suite 2.0

 Integration via database 107

Example of asset structure insertion/editing/deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 3, 109, 'Computer#152',
'01', 'Monitor#328', '01', '1');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (2, 1, 3, 109, 'Computer#152',
'01', 'Monitor#328', '01', '3');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (3, 1, 4, 109, 'Computer#152', '01',
'Monitor#328', '01');

Integration guide — SE Suite 2.0

 Integration via database 108

4.6.4.11 - ASTTYPE - Import of asset types

This import template enables to insert/edit/delete:

§ Data of an asset type.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete asset type

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

109 - C ode of component SE Asset.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 10 - Insert asset type. If it exists, edits it;

11 - Delete asset type.

Asset type ID # (for deletion, only this

NMFIELD01 X TEXT 255
field is required).

NMFIELD02 X TEXT 255 Asset type name.

NMFIELD03 TEXT 255 Upper level asset type.

Use identification mask:

NMFIELD04 TEXT 255 1 - Yes;

X
2 - No.

Identification mask ID # (required if the

NMFIELD05 TEXT 255 option to use identification mask is equal
to 1).

Allow editing the ID # generated by the

identification mask (required if the option

NMFIELD06 TEXT 255 to use identification mask is equal to 1):

1 - Yes;

2 - No.

Integration guide — SE Suite 2.0

 Integration via database 109

Revision control:

NMFIELD07 X TEXT 255 1 - Yes;

2 - No.

Revision ID # (required if the option to

control the revision is equal to 1):

NMFIELD08 TEXT 255 1 - Numeric;

2 - Text;

3 - C ustomized.

Approval method (required if the option to

control the revision is equal to 1):
NMFIELD09 TEXT 255
1 - Incremental;

2 - C ircular.

C losure (required if the option to control

the revision is equal to 1):
NMFIELD10 TEXT 255
1 - Automatic;

2 - Manual.

NMFIELD11 TEXT 255 Number of retentions of obsolete revisions.

Default retention frequency:

1 - Revisions;
NMFIELD12 TEXT 255
2 - Months;

3 - Years.

Route type (required if the option to

control the revision is equal to 1):
NMFIELD13 TEXT 255
1 - Fixed;

2 - Variable.

Acceptance of revision draft (required if

the option to control the revision is equal

NMFIELD14 TEXT 255 to 1):

1 - AND;

2 - OR.

Acceptance of review revision (required if

the option to control the revision is equal

NMFIELD15 TEXT 255 to 1):

1 - AND;

2 - OR.

Acceptance of approval revision (required

NMFIELD16 TEXT 255
if the option to control the revision is equal

Integration guide — SE Suite 2.0

 Integration via database 110

to 1):

1 - AND;

2 - OR.

Acceptance of Release revision (required if

the option to control the revision is equal

NMFIELD17 TEXT 255 to 1):

1 - AND;

2 - OR.

Example of insertion/editing/deletion of asset types:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08) VALUES
(1, 1, 10, 109, 'Calipers', 'Calipers', '', '2', '', '', '2');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08) VALUES
(1, 1, 10, 109, 'Cal', 'Calipers', '', '2', '', '', '2');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (3, 1, 11, 109, 'Cal');

Integration guide — SE Suite 2.0

 Integration via database 111

4.6.5 - Calibration

This section contains the following topics:

§ CACALIBRATION - Calibration data import

§ CAPOINT - Calibration table point data import

§ CATABLE - Calibration table data import

Integration guide — SE Suite 2.0

 Integration via database 112

4.6.5.1 - CACALIBRATION - Calibration data import

This import template enables to insert, edit, or delete:

§ Calibration data

To insert each of these items, it is necessary to follow the standard documented below.

Insert, edit, and delete Calibration data

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

115 – C ode of component SE C alibration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 1 – Edit / Edit;

2 – Delete.

NMFIELD01 X TEXT 255 Asset ID #.

NMFIELD02 X1 TEXT 255 C ertificate #.

NMFIELD03 X TEXT 255 Start date.

NMFIELD04 X TEXT 255 Start time.

NMFIELD05 X TEXT 255 End date.

NMFIELD06 X TEXT 255 End time.

NMFIELD07 X TEXT 255 Service center ID #.

Responsible user ID # if the service center

NMFIELD08 X TEXT 255 is internal or, otherwise, name of the
responsible user.

NMFIELD09 X TEXT 255 Activity classification ID #.

Integration guide — SE Suite 2.0

 Integration via database 113

C alibration result (required if the

calibration configuration has no table and
point):
NMFIELD10 TEXT 255
1 - Approved;

2 - C onditionally approved;

3 - Rejected.

Pre-calibration result (required if the

calibration configuration has no table and

NMFIELD11 TEXT 255 point and uses the Schumacher method):

1 – Approved;

2 - Rejected.

§ X 1 – Only the “C ertificate #” field is required during the deletion of the calibration activity.

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09) VALUES (1, 1, 115, 1, 'CAL-001', '00001', '09/04/2014', '16:00',
'09/04/2014', '17:00', 'MAINT', '1371', 'Cal');

Example of deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD02)

VALUES (1, 1, 115, 2, '00001');

Integration guide — SE Suite 2.0

 Integration via database 114

4.6.5.2 - CAPOINT - Calibration table point data import

This import template enables to edit:

§ Calibration table point data

To insert this item, it is necessary to follow the standard documented below.

Insert, edit, and delete Calibration data

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

115 – C ode of component SE C alibration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
12 – Edit.

NMFIELD01 X TEXT 255 Asset ID #.

NMFIELD02 X TEXT 255 C ertificate #.

NMFIELD03 X TEXT 255 C alibration table name.

NMFIELD04 X TEXT 255 Point name.

Indicates the point type:

NMFIELD05 X1 TEXT 255 1 – Rising point;

2 – Descent point.

Indicates whether it is the case of a pre-

calibration or calibration:
NMFIELD06 X TEXT 255
1 – Pre-calibration;

2 – C alibration.

NMFIELD07 X2 TEXT 255 Trend or systematic error value [Bias].

NMFIELD08 X2 TEXT 255 Total deviation value [Fges].

NMFIELD09 X2 TEXT 255 Deviation value [Fe].

Integration guide — SE Suite 2.0

 Integration via database 115

NMFIELD10 X2 TEXT 255 Expanded uncertainty value [U95].

NMFIELD11 X2 TEXT 255 Ascending error value [Ascending error].

Descending error value [Descending

NMFIELD12 X2 TEXT 255
error].

NMFIELD13 X2 TEXT 255 Range error value [Range error].

NMFIELD14 X2 TEXT 255 Average value [Average].

The highest reading value [The highest

NMFIELD15 X2 TEXT 255
reading].

The lowest reading value [the lowest

NMFIELD16 X2 TEXT 255
reading].

NMFIELD17 X2 TEXT 255 Hysteresis value [Hysteresis].

NMFIELD18 X2 TEXT 255 FT value [FT].

NMFIELD19 TEXT 255 Process ID #

C omplementary variable.

Format: [variable ID #]=VALUE;

NMFIELD20 X2 TEXT 255
[variable ID #]=VALUE;

Example: g=9.81; UPAD=0.01.

NMFIELD21 TEXT 255 C .T.V. value.

§ X 1 – Required in case of hysteresis.

§ X 2 – Required if the variable is part of the formula.

Example of editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD06, NMFIELD07, NMFIELD10) VALUES (1, 1, 115,
12, 'PAQ-001', 'CERT-001', 'TAB-01', 'POINT-01', '1', '5', '0.5');

Integration guide — SE Suite 2.0

 Integration via database 116

4.6.5.3 - CATABLE - Calibration table data import

This import template enables to edit:

§ Calibration table data

To insert this item, it is necessary to follow the standard documented below.

Insert, edit, and delete Calibration data

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

115 – C ode of component SE C alibration.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
11 – Edit;

NMFIELD01 X TEXT 255 Asset ID #.

NMFIELD02 X TEXT 255 C ertificate #.

NMFIELD03 X TEXT 255 C alibration table name.

Indicates whether it is the case of a pre-

calibration or calibration:
NMFIELD04 X TEXT 255
1 – C alibration;

2 – Pre-calibration.

NMFIELD05 X1 TEXT 255 Trend or systematic error value [Bias].

NMFIELD06 X1 TEXT 255 Total deviation value [Fges].

NMFIELD07 X1 TEXT 255 Deviation value [Fe].

NMFIELD08 X1 TEXT 255 Expanded uncertainty value [U95].

NMFIELD09 X1 TEXT 255 Ascending error value [Ascending error].

Descending error value [Descending

NMFIELD10 X1 TEXT 255
error].

Integration guide — SE Suite 2.0

 Integration via database 117

NMFIELD11 X1 TEXT 255 Range error value [Range error].

NMFIELD12 X1 TEXT 255 Average value [Average].

The highest reading value [The highest

NMFIELD13 X1 TEXT 255
reading].

The lowest reading value [the lowest

NMFIELD14 X1 TEXT 255
reading].

NMFIELD15 X1 TEXT 255 Hysteresis value [Hysteresis].

NMFIELD16 X1 TEXT 255 FT value [FT].

NMFIELD17 TEXT 255 Process ID #

C omplementary variable.

Format: [variable ID #]=VALUE;

NMFIELD18 X1 TEXT 255
[variable ID #]=VALUE;

Example: g=9.81; UPAD=0.01.

Subjective table calibration result:

NMFIELD19 X2 TEXT 255 1 = Approved;

2 = Rejected.

Subjective table pre-calibration result:

NMFIELD20 X2 TEXT 255 1 = Approved;

2 = Rejected.

NMFIELD21 TEXT 255 Subjective table comments.

§ X 1 – Required field if it is part of the formula.

§ X 2 – Required field if the table is subjective.

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD08) VALUES (1, 1, 115, 11, 'CAL-001', 'CERT-
001', 'TAB-01', '1', '5', '0.5', '1');

Integration guide — SE Suite 2.0

 Integration via database 118

4.6.6 - SPC

This section contains the following topics:

§ SPCSAMPATT - Attribute characteristic sample import

§ SPCSAMPCHANGESTATUS – Sample status update

§ SPCSAMPVAR - Variable characteristic sample import

Integration guide — SE Suite 2.0

 Integration via database 119

4.6.6.1 - SPCSAMPATT - Attribute characteristic sample

import

This import template enables to insert/edit:

§ Attribute characteristic sample data;

§ Attribute characteristic sample defect data;

§ Attribute characteristic sample defect cause data

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete attribute characteristic sample

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

116 - C ode of component SE SPC .

C ode of the operation to be performed:

3 - Insert attribute characteristic sample; if

FGOPTION X NUMERIC 2
it exists, updates its data;

4 - Delete attribute characteristic sample.

C ollection number (required field for

NMFIELD01 X TEXT 255
deletion).

C haracteristic ID # (field required for

NMFIELD02 X TEXT 255
deletion).

Sample number (field required for

deletion).
NMFIELD03 TEXT 255
Note: If not entered, the system will use
the previous sample and add up one unit.

NMFIELD04 X TEXT 255 Sample date (mm/dd/yyyy).

NMFIELD05 X TEXT 255 Time (hh:mm).

Integration guide — SE Suite 2.0

 Integration via database 120

Flag to reconstitute the sample general

data:
NMFIELD06 X TEXT 255
1 - Previous sample;

2 - C haracteristic.

Machine ID # (required depending on the

NMFIELD07 TEXT 255
system parameterization).

Operator ID # (required depending on the

NMFIELD08 TEXT 255
system parameterization).

Inspector ID # (required depending on the

NMFIELD09 TEXT 255
system parameterization).

Shift ID # (required depending on the

NMFIELD10 TEXT 255
system parameterization).

Gage ID # (required depending on the

NMFIELD11 TEXT 255
system parameterization).

Lot number (required depending on the

NMFIELD12 TEXT 255
system parameterization).

O.F. number (required depending on the

NMFIELD13 TEXT 255
system parameterization).

NMFIELD14 X TEXT 255 Quantity of items.

NMFIELD15 X TEXT 255 Quantity of defective items.

NMFIELD16 X TEXT 255 Quantity of rejected items.

Workflow ID # (required if the collection

NMFIELD17 TEXT 255 object is a workflow or a workflow
activity).

List of defects and their respective

quantities separated by semicolon (;) and
colon (:). If the ID # contains one of the
two delimiting characters, use backslash
DSFIELD01 TEXT 4000
(\) as the antecedent character, according
to the format:

Format:
DEFEC T01:3;DEFEC T\;02:4

Examples of insertion/editing/deletion of attribute characteristic sample:

Integration guide — SE Suite 2.0

 Integration via database 121

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD14, DSFIELD01) VALUES
(1, 1, 3, 116, '000001', 'Visual', '10', '11/30/2009', '10:00', '1', 'CNC lathe',
'John', 'Peter', '1T', 'Visual', '#RSQ002', 'OF47227', '50', '10', '1',
'DEFECT01:3;DEFECT\;02:4');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD14, DSFIELD01) VALUES
(2, 1, 3, 116, '000001', 'Visual', '', '01/20/2009', '10:00', '1', 'CNC lathe',
'John', 'Peter', '1T', 'Visual', '#RSQ002', 'OF47227', '50', '10', '0',
'DEFECT01:3;DEFECT\;02:4');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (3, 1, 4, 116, '000001', 'Visual', '11');

Insert/edit/delete attribute characteristic sample defect

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

116 - C ode of component SE SPC .

C ode of the operation to be performed:

5 - Insert attribute characteristic sample

FGOPTION X NUMERIC 2 defect; if it exists, updates its data;

8 - Delete attribute characteristic sample

defect (sets the defects as 0).

C ollection number (required field for

NMFIELD01 X TEXT 255
deletion).

Integration guide — SE Suite 2.0

 Integration via database 122

C haracteristic ID # (field required for

NMFIELD02 X TEXT 255
deletion).

Sample number (field required for

NMFIELD03 X TEXT 255
deletion).

NMFIELD04 X TEXT 255 Defect ID # (field required for deletion).

NMFIELD05 X TEXT 255 Quantity of defects.

Example of insertion/editing/deletion of attribute characteristic sample defect:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 5, 116, '000001',
'Visual', '10', 'Crack', '1');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 5, 116, '000001',
'Visual', '10', 'Scratch', '1');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (1, 1, 6, 116, '000001', 'Visual', '10',
'Scratch');

Insert/edit/delete attribute characteristic sample defect cause

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

116 - C ode of component SE SPC .

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 7 - Insert attribute characteristic sample
defect cause; if it exists, updates its data;

Integration guide — SE Suite 2.0

 Integration via database 123

8 - Delete attribute characteristic sample

defect cause (sets the cause as 0).

C ollection number (required field for

NMFIELD01 X TEXT 255
deletion).

C haracteristic ID # (field required for

NMFIELD02 X TEXT 255
deletion).

Sample number (field required for

NMFIELD03 X TEXT 255
deletion).

NMFIELD04 X TEXT 255 Defect ID # (field required for deletion).

NMFIELD05 X TEXT 255 C ause ID # (field required for deletion).

NMFIELD06 X TEXT 255 Quantity of causes.

Example of insertion/editing/deletion of attribute characteristic sample defect cause:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05)
VALUES (1, 1, 7, 116, '000001', 'Visual', '10', 'Scratch', 'Raw material', '1');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05)
VALUES (1, 1, 7, 116, '000001', 'Visual', '10', 'Scratch', 'Shift change', '1');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04)
VALUES (1, 1, 8, 116, '000001', 'Visual', '10', 'Scratch', 'Shift change');

Integration guide — SE Suite 2.0

 Integration via database 124

4.6.6.2 - SPCSAMPCHANGESTATUS – Sample status update

This import template enables to edit:

§ Status of the sample of a collection;

To insert each of these items, it is necessary to follow the standard documented below.

Change sample status

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

116 - C ode of component SE SPC .

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 9 - C hange the status of a collection
sample.

NMFIELD01 X TEXT 255 C ollection ID #.

NMFIELD02 X TEXT 255 C haracteristic ID #.

NMFIELD03 X TEXT 255 Sample ID #.

Example of status change:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 9, 116, '000001', 'Weight', '10');

Integration guide — SE Suite 2.0

 Integration via database 125

4.6.6.3 - SPCSAMPVAR - Variable characteristic sample

import

This import template enables to insert/edit:

§ Variable characteristic sample data;

To insert each of these items, it is necessary to follow the standard documented below.
Insert/edit/delete variable characteristic sample

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

116 - C ode of component SE SPC .

C ode of the operation to be performed:

3 - Insert variable characteristic sample; if

FGOPTION X NUMERIC 2
it exists, updates its data;

2 - Delete variable characteristic sample.

C ollection number (required field for

NMFIELD01 X TEXT 255
deletion).

C haracteristic ID # (field required for

NMFIELD02 X TEXT 255
deletion).

Sample number (field required for

deletion).
NMFIELD03 TEXT 255
Note: If not entered, the system will use
the previous sample and add up one unit.

NMFIELD04 X TEXT 255 Sample date (mm/dd/yyyy).

NMFIELD05 X TEXT 255 Time (hh:mm).

Flag to reconstitute the sample general

data:
NMFIELD06 X TEXT 255
1 - Previous sample;

2 – C haracteristic.

Integration guide — SE Suite 2.0

 Integration via database 126

Machine ID # (required depending on the

NMFIELD07 TEXT 255
system parameterization).

Operator ID # (required depending on the

NMFIELD08 TEXT 255
system parameterization).

Inspector ID # (required depending on the

NMFIELD09 TEXT 255
system parameterization).

Shift ID # (required depending on the

NMFIELD10 TEXT 255
system parameterization).

Gage ID # (required depending on the

NMFIELD11 TEXT 255
system parameterization).

Lot number (required depending on the

NMFIELD12 TEXT 255
system parameterization).

O.F. number (required depending on the

NMFIELD13 TEXT 255
system parameterization).

Reading values (readings must be

NMFIELD14 X TEXT 255 separated by “;” and use "." as decimal
separator).

Workflow ID # (required if the collection

NMFIELD15 TEXT 255 object is a workflow or a workflow
activity).

Example of insertion/editing/deletion of variable characteristic sample:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,
NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD14) VALUES (1, 1, 1,
116, '000001', 'Weight', '15', '01/01/2009', '10:00', '1', 'CNC lathe', 'John',
'Peter', '1T', 'Cal#001', '#RSQ001', 'OF47226', '5.00;4.98;5.15');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD14) VALUES (2, 1, 1,
116, '000001', 'Weight', '', '01/01/2009', '12:00', '1', 'CNC lathe', 'John',
'Peter', '1T', 'Cal#001', '#RSQ001', 'OF47226', '5.20;5.18;4.95');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (3, 1, 2, 116, '000001', 'Weight', '16');

Integration guide — SE Suite 2.0

 Integration via database 127

4.6.7 - Competence

This section contains the following topics:

§ CPTREG - Competence

Integration guide — SE Suite 2.0

 Integration via database 128

4.6.7.1 - CPTREG - Competence

This import template enables to insert, edit, and delete:

§ Competencies

In order to add, edit and delete each of these items, it is necessary to follow the standard documented below.

Add/edit/delete data

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

171 - C ompetence component code.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 1 - Addition/edition of competencies;

2 - Deletion of competencies.

C ompetence ID # (for deletions, only this

NMFIELD01 X TEXT 255
field is required).

NMFIELD02 X TEXT 255 C ompetence name.

NMFIELD03 X TEXT 255 C ompetence type id #.

NMFIELD04 X TEXT 255 Proficiency scale id #.

NMFIELD05 X TEXT 255 Proficiency scale revision number.

DSFIELD01 TEXT 4000 C ompetence description.

DSFIELD02 TEXT 4000 C ompetence objective.

Example of addition/edition:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, DSFIELD01, DSFIELD02)

Integration guide — SE Suite 2.0

 Integration via database 129

VALUES (1, 1, 171, 1, 'CPT01', 'Competence', 'TC02', 'EP01', 0, 'Competence

description', 'Competence objective);

Example of deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01)

VALUES (2, 1, 171, 2, 'CPT01');

Integration guide — SE Suite 2.0

 Integration via database 130

4.6.8 - Time control

This section contains the following topics:

§ WRFINANCE – Financial import

§ WRRESOURCE – Resource value import

§ WRTIME – Timesheet import

Integration guide — SE Suite 2.0

 Integration via database 131

4.6.8.1 - WRFINANCE - Financial import

This import template enables to insert/edit:

§ Financial values into projects/project tasks/nonproject tasks

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

205 – C ode of component SE Time control.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
2 – Insert financial value.

Operation to be performed:

NMFIELD01 X NUMERIC 2 1 – Add;

2 – Edit;

NMFIELD02 X TEXT 255 Projects/Nonproject task ID #.

Project task ID #.
NMFIELD03 X TEXT 255
(Will only be validated if it is a project).

Identifies whether the financial record is

from a project task or from a nonproject
task:
NMFIELD04 NUMERIC 2
X 1 – Project task;

2 – Project;

3 – Nonproject task;

Financial entry type:

NMFIELD05 X NUMERIC 2 1 – C ost;

2 – Revenue;

NMFIELD06 X TEXT 255 C ost or revenue name.

Integration guide — SE Suite 2.0

 Integration via database 132

NMFIELD07 X TEXT 255 C ost or revenue type (Financial type).

NMFIELD08 NUMERIC 10 Document number.

C ost or revenue actual date. Date format:

NMFIELD09 X TEXT 255
DD/MM/YYYY or YYYY-MM-DD.

NMFIELD10 X NUMERIC 10 C ost or revenue unit amount.

NMFIELD11 X NUMERIC 10 C ost or revenue unit value.

DSFIELD01 TEXT 255 C ost description for the task.

Import type:

1 – Planning;
NMFIELD12 X NUMERIC 2
2 – Re-planning;

3 – Actual;

NMFIELD22 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD23 TEXT 255
NMFIELD22 field.

NMFIELD24 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD25 TEXT 255
NMFIELD24 field.

NMFIELD26 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD27 TEXT 255
NMFIELD26 field.

NMFIELD28 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD29 TEXT 255
NMFIELD28 field.

NMFIELD30 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD31 TEXT 255
NMFIELD30 field.

NMFIELD32 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD33 TEXT 255
NMFIELD32 field.

NMFIELD34 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD35 TEXT 255
NMFIELD34 field.

NMFIELD36 TEXT 255 Attribute ID #.

Integration guide — SE Suite 2.0

 Integration via database 133

Value of the attribute specified in the

NMFIELD37 TEXT 255
NMFIELD36 field.

NMFIELD38 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD39 TEXT 255
NMFIELD38 field.

NMFIELD40 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD41 TEXT 255
NMFIELD40 field.

NMFIELD42 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD43 TEXT 255
NMFIELD42 field.

NMFIELD44 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD45 TEXT 255
NMFIELD44 field.

NMFIELD46 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD47 TEXT 255
NMFIELD46 field.

NMFIELD48 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD49 TEXT 255
NMFIELD48 field.

NMFIELD50 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD51 TEXT 255
NMFIELD50 field.

NMFIELD52 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD53 TEXT 255
NMFIELD52 field.

NMFIELD54 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD55 TEXT 255
NMFIELD54 field.

NMFIELD56 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD57 TEXT 255
NMFIELD56 field.

NMFIELD58 TEXT 255 Attribute ID #.

Integration guide — SE Suite 2.0

 Integration via database 134

Value of the attribute specified in the

NMFIELD59 TEXT 255
NMFIELD58 field.

NMFIELD60 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD61 TEXT 255
NMFIELD60 field.

NMFIELD62 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD63 TEXT 255
NMFIELD62 field.

NMFIELD64 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD65 TEXT 255
NMFIELD64 field.

NMFIELD66 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD67 TEXT 255
NMFIELD66 field.

NMFIELD68 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD69 TEXT 255
NMFIELD68 field.

NMFIELD70 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD71 TEXT 255
NMFIELD70 field.

NMFIELD72 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD73 TEXT 255
NMFIELD72 field.

NMFIELD74 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD75 TEXT 255
NMFIELD74 field.

Example of a cost insertion into a project task:

§ Planning:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04) VALUES (205, 8, 2, 1, 1, 'PROJECT', '1', 1, 'COST
TYPE 1', 'TC1', '2010-07-08', 12, 125, 1, 1);

Integration guide — SE Suite 2.0

 Integration via database 135

§ Re-planning:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04) VALUES (205, 7, 2, 1, 1, 'PROJECT', '1', 1, 'COST
YPE2', 'TC2', '2010-07-12', 21, 47, 2, 1);

§ Actual:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04) VALUES (205, 9, 2, 1, 1, 'PROJECT', '1', 1, 'COST
TYPE3', 'TC3', '2010-07-21', 2, 2107, 3, 1);

Example of a revenue insertion into a project task:

§ Planning:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04) VALUES (205, 11, 2, 1, 1, 'PROJECT', '1', 2,
'REVENUE TYPR1', 'TR1', '2010-07-08', 12, 125, 1, 1);

§ Re-planning:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04) VALUES (205, 10, 2, 1, 1, 'PROJECT', '1', 2,
'REVENUE TYPE2', 'TR2', '2010-07-12', 21, 47, 2, 1);

§ Actual:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04) VALUES (205, 12, 2, 1, 1, 'PROJECT', '1', 2,
'REVENUE TYPE3', 'TR3', '2010-07-21', 2, 2107, 3, 1);

Integration guide — SE Suite 2.0

 Integration via database 136

Example of a cost insertion into a nonproject task:

§ Planning:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04) VALUES (205, 2, 2, 1, 1, 'NONPROJECT TASK', 1, 'COST TYPE1',
'TC1', '2010-07-08', 2, 125, 1, 3);

§ Re-planning:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04) VALUES (205, 1, 2, 1, 1, 'NONPROJECT TASK', 1, 'COST TYPE2',
'TC2', '2010-07-12', 2, 27, 2, 3);

§ Actual:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04) VALUES (205, 3, 2, 1, 1, 'NONPROJECT TASK', 1, 'COST TYPE3',
'TC3', '2010-07-21', 2, 207, 3, 3);

Example of a revenue insertion into a nonproject task:

§ Planning:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04) VALUES (205, 5, 2, 1, 1, 'NONPROJECT TASK', 2, 'REVENUE
TYPE1', 'TR1', '2010-07-08', 2, 125, 1, 3);

§ Re-planning:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04) VALUES (205, 4, 2, 1, 1, 'NONPROJECT TASK', 2, 'REVENUE
TYPE2', 'TR2', '2010-07-12', 2, 27, 2, 3);

Integration guide — SE Suite 2.0

 Integration via database 137

§ Actual:

INSERT INTO ADINTERFACE (CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04) VALUES (205, 6, 2, 1, 1, 'NONPROJECT TASK', 2, 'REVENUE
TYPE3', 'TR3', '2010-07-21', 2, 207, 3, 3);

Integration guide — SE Suite 2.0

 Integration via database 138

4.6.8.2 - WRRESOURCE - Resource value import

This import template enables to insert/edit:

§ Resource values

To insert each of these items, it is necessary to follow the standard documented below.

Add/edit resource values

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

205 – C ode of component SE Time control.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
3 – Insert resource value.

NMFIELD01 X TEXT 255 Resource ID # or name.

NMFIELD02 X TEXT 255 C alendar ID # or name.

C ost date – Date in format DD/MM/YYYY or

YYYY-MM-DD. Required to create a new
NMFIELD03 TEXT 255
cost range. Field NULL represents the initial
range of the cost.

C ost – regular working hour value.

NMFIELD04 TEXT 255 Required to create a new cost range for a
Labor or Asset resource type.

C ost – Overtime rate. Required to create a

NMFIELD05 TEXT 255 new cost range for the Labor resource
type.

C ost – Weekend rate. Required to create a

NMFIELD06 TEXT 255 new cost range for the Labor resource
type.

C ost – Percentage value. Required to

NMFIELD07 TEXT 255
create a new cost range for the Labor

Integration guide — SE Suite 2.0

 Integration via database 139

resource type.

Billing date – Date in format DD/MM/YYYY

or YYYY-MM-DD. Required to create a new
NMFIELD08 TEXT 255
billing range. Field NULL represents the
initial range of the billing.

Billing – Regular working hour value.

NMFIELD09 TEXT 255 Required to create a new billing range for
the Work or Asset resource type.

Billing – Overtime rate. Required to create

NMFIELD10 TEXT 255 a new billing range for the Labor resource
type.

Billing – Weekend rate. Required to create

NMFIELD11 TEXT 255 a new billing range for the Labor resource
type.

Billing – Daily rate. Required to create a

NMFIELD12 TEXT 255 new billing range for the Asset resource
type.

Example of calendar and initial values of the cost and the billing association for the Labor resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (1, 1, 205, 3, 'User',
'Calendar', NULL, '1', '2', '2', NULL, NULL, '4', '6', '4', NULL);

Example of cost insertion/update for the Labor resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (12, 1, 205, 3, 'User',
'Calendar', '2010-01-01', '1', '2', '2', NULL, NULL, NULL, NULL, NULL, NULL);

Example of billing insertion/update for the Labor resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (3, 1, 205, 3, 'User',
'Calendar', NULL, NULL, NULL, NULL, NULL, '2010-01-01', '4', '6', '4', NULL);

Integration guide — SE Suite 2.0

 Integration via database 140

Example of calendar and initial values of the cost and the billing association for the Asset resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (1, 1, 205, 3, 'User',
'Calendar', NULL, '1', NULL, NULL, '2', NULL, '4', NULL, NULL, '6');

Example of cost insertion/update for the Asset resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (2, 1, 205, 3, 'User',
'Calendar', '2010-01-01', '1', NULL, NULL, '2', NULL, NULL, NULL, NULL, NULL);

Example of billing insertion/update for the Asset resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (3, 1, 205, 3, 'User',
'Calendar', NULL, NULL, NULL, NULL, NULL, '2010-01-01', '4', NULL, NULL, '6');

Example of calendar association for the Work or Asset resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (4, 1, 205, 3, 'User',
'Calendar', NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);

Integration guide — SE Suite 2.0

 Integration via database 141

4.6.8.3 - WRTIME - Timesheet import

This import template enables to insert/edit:

§ Timesheet

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit timesheet
Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

205 – C ode of component SE Time control.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
1 – Insert timesheet.

NMFIELD01 X TEXT 255 Object ID #.

NMFIELD02 X TEXT 255 Activity ID #.

NMFIELD03 TEXT 255 Task WBS.

Timesheet date. Date format:

NMFIELD04 TEXT 255
X DD/MM/YYYY or YYYY-MM-DD.

Timesheet start time. Required if total is

NMFIELD05 X TEXT 255
not entered.

Timesheet end time. Required if total is not

NMFIELD06 X TEXT 255
entered.

Timesheet total time. Required if start and

NMFIELD07 X TEXT 255
end time are not entered.

Hour type:

NMFIELD08 X TEXT 255 1 – Regular hour;

2 – Overtime;

NMFIELD09 X TEXT 255 Resource ID # or name.

Integration guide — SE Suite 2.0

 Integration via database 142

Task type:

1 – Project task;

2 – Nonproject task;

NMFIELD10 X TEXT 255 3 – Monitored event;

4 – Meeting;

5 – Isolated action;

6 – Action plan action;

NMFIELD22 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD23 TEXT 255
NMFIELD22 field.

NMFIELD24 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD25 TEXT 255
NMFIELD24 field.

NMFIELD26 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD27 TEXT 255
NMFIELD26 field.

NMFIELD28 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD29 TEXT 255
NMFIELD28 field.

NMFIELD30 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD31 TEXT 255
NMFIELD30 field.

NMFIELD32 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD33 TEXT 255
NMFIELD32 field.

NMFIELD34 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD35 TEXT 255
NMFIELD34 field.

NMFIELD36 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD37 TEXT 255
NMFIELD36 field.

NMFIELD38 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD39 TEXT 255
NMFIELD38 field.

Integration guide — SE Suite 2.0

 Integration via database 143

NMFIELD40 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD41 TEXT 255
NMFIELD40 field.

NMFIELD42 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD43 TEXT 255
NMFIELD42 field.

NMFIELD44 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD45 TEXT 255
NMFIELD44 field.

NMFIELD46 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD47 TEXT 255
NMFIELD46 field.

NMFIELD48 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD49 TEXT 255
NMFIELD48 field.

NMFIELD50 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD51 TEXT 255
NMFIELD50 field.

NMFIELD52 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD53 TEXT 255
NMFIELD52 field.

NMFIELD54 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD55 TEXT 255
NMFIELD54 field.

NMFIELD56 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD57 TEXT 255
NMFIELD56 field.

NMFIELD58 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD59 TEXT 255
NMFIELD58 field.

NMFIELD60 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD61 TEXT 255
NMFIELD60 field.

NMFIELD62 TEXT 255 Attribute ID #.

Integration guide — SE Suite 2.0

 Integration via database 144

Value of the attribute specified in the

NMFIELD63 TEXT 255
NMFIELD62 field.

NMFIELD64 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD65 TEXT 255
NMFIELD64 field.

NMFIELD66 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD67 TEXT 255
NMFIELD66 field.

NMFIELD68 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD69 TEXT 255
NMFIELD68 field.

NMFIELD70 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD71 TEXT 255
NMFIELD70 field.

NMFIELD72 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD73 TEXT 255
NMFIELD72 field.

NMFIELD74 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD75 TEXT 255
NMFIELD74 field.

DSFIELD01 TEXT 4000 Timesheet comments.

Example of timesheet insertion/editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD08, NMFIELD09,
DSFIELD01) VALUES (1, 1, 205, 1, '000001', '000001', '1', '2010-01-01', '08:00',
'18:00', '1', '000001', 'Notes');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD07, NMFIELD08, NMFIELD09, DSFIELD01,
NMFIELD22, NMFIELD23, NMFIELD24, NMFIELD25) VALUES (1, 1, 205, 1, '000001',
'000001', '1', '2010-01-01', '08:00', '1', '000001', 'Notes', 'Attribute 1',
'Attribute value 1', 'Attribute 2', 'Attribute value 2');

Integration guide — SE Suite 2.0

 Integration via database 145

4.6.9 - Performance

This section contains the following topics:

§ STRITEM - Item import

§ STRMETRIC - Indicator import

§ STRSCITEM - Item structure import

§ STRSCMETRIC - Import of Scorecard indicators

§ STRSCSUBMETRIC - Sub-indicator import

§ STRVALUES - Import of target/measurement of indicators

§ STRSCORECARD - Import of template-based Scorecard

§ STRSCORECARDACCESS - Insertion of Scorecard security

§ STRDELSCORECARDACCESS - Deletion of Scorecard security

§ STRSCOREACCESSMTR - Insertion of default security for Scorecard indicator/element

§ STRDELSCOREACCESSMTR - Deletion of default security for Scorecard indicator/element

Integration guide — SE Suite 2.0

 Integration via database 146

4.6.9.1 - STRITEM - Item import

This import template makes it possible to insert:

§ Items to be used in Scorecard. Items must have an element created previously.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 - C ode of component SE Performance.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
1 - Insert item.

NMFIELD01 X TEXT 255 Item ID #.

NMFIELD02 X TEXT 255 Item name.

NMFIELD03 X TEXT 255 Element ID #.

DSFIELD01 TEXT 4000 Item description.

Example of item insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD02,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (1, 1, 138, 1, 'IT', 'Item', 'Element',
'Description');

Integration guide — SE Suite 2.0

 Integration via database 147

4.6.9.2 - STRMETRIC - Indicator import

This import template makes it possible to insert:

§ Indicators to be used in the Scorecard.

To insert each of these indicators, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 - C ode of component SE Performance.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
2 - Insert indicator.

NMFIELD01 X TEXT 255 Indicator ID #.

NMFIELD02 X TEXT 255 Indicator name.

NMFIELD03 X TEXT 255 Indicator type ID #.

NMFIELD04 X TEXT 255 Measurement unit ID #.

NMFIELD05 X NUMERIC 10 Number of decimal places.

Indicator frequency:

1 - Yearly;

2 - Biannual;

3 - Four-month-period;

NMFIELD06 X NUMERIC 2 4 - Quarterly;

5 - Bimonthly;

6 - Monthly;

7 - Bi-weekly;

8 - Weekly;

Integration guide — SE Suite 2.0

 Integration via database 148

9 - Daily;

10 - Based on event

NMFIELD07 NUMERIC 10 Number of years for yearly frequency.

Automatic accumulation type:

1 - Sum;

NMFIELD08 X NUMERIC 2 2 - Average;

3 - None;

4 - Manual.

Frequency for accumulation:

1 - Yearly;

2 - Biannual;

3 - Four-month-period;

4 - Quarterly;
NMFIELD09 NUMERIC 2
5 - Bimonthly;

6 - Monthly;

7 - Bi-weekly;

8 - Weekly;

9 - Daily.

Number of years for yearly accumulation

NMFIELD10 NUMERIC 10
frequency.

NMFIELD11 NUMERIC 10 Accumulation start period.

NMFIELD12 X TEXT 255 Default range ID #.

Does the indicator have target?

NMFIELD13 NUMERIC 2 1 - Yes (default value);

2 - No.

Indicates the indicator classification:

NMFIELD14 Numeric 2 1 - Qualitative;

2 - Quantitative (default value).

DSFIELD04 TEXT 4000 Indicator description.

Integration guide — SE Suite 2.0

 Integration via database 149

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD14, DSFIELD01) VALUES
(1, 1, 138, 2, 'IND', 'Indicator', 'Indicator Type', 'Unit', '2', '1', '1', '4',
'6', '2', '1', 'Range', '1', '2', 'Description');

Integration guide — SE Suite 2.0

 Integration via database 150

4.6.9.3 - STRSCITEM - Item structure import

This import template makes it possible to insert:

§ Items into the Scorecard. Items may be configured according to the customer needs. Examples: objectives,

perspectives, condition, department, etc.

To insert each of these items, it is necessary to follow the standard documented below.
Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 - C ode of component SE Performance.

C ode of the operation to be performed:

FGOPTION X NUMERIC 3
3 - Insert scorecard Item.

NMFIELD01 X TEXT 255 Scorecard item ID #.

NMFIELD02 TEXT 255 Scorecard upper level item ID #.

NMFIELD03 X TEXT 255 Item ID #.

NMFIELD04 X TEXT 255 Scorecard ID #

Range ID #. Uses the scorecard range by

NMFIELD05 TEXT 255
default.

Use default scale??

0 - No;
NMFIELD06 NUMERIC 2
1 - Yes (Score value) (Default);

2 - Yes (% value).

NMFIELD09 NUMERIC 10 View order.

Item value weight. If no value is entered,

NMFIELD10 NUMERIC 10 the system will consider 1.00 as the
weight.

Integration guide — SE Suite 2.0

 Integration via database 151

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD09, NMFIELD10) VALUES
(1, 1, 138, 3, 'ITdS', 'Scorecard Top Item', 'Scorecard Item', 'Scorecard', 'Range',
'2', '1', '1');

Integration guide — SE Suite 2.0

 Integration via database 152

4.6.9.4 - STRSCMETRIC - Import of Scorecard indicators

This import template makes it possible to insert:

§ Scorecard indicators.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 - C ode of component SE Performance.

C ode of the operation to be performed:

FGOPTION X NUMERIC 3
4 - Insert scorecard indicator.

NMFIELD01 X TEXT 255 Scorecard indicator ID #.

NMFIELD02 X TEXT 255 Indicator ID #.

NMFIELD03 TEXT 255 Upper level structure item ID #.

NMFIELD04 X TEXT 255 Scorecard ID #

Use default scale??

0 - No;
NMFIELD06 NUMERIC 2
1 - Yes (Score value) (Default);

2 - Yes (% value).

ID # of the team responsible for the

NMFIELD07 X TEXT 255
measurement.

ID # of the team responsible for the

NMFIELD09 X TEXT 255
target.

Integration guide — SE Suite 2.0

 Integration via database 153

View security:

NMFIELD10 NUMERIC 2 1 - Public (Default);

2 - Restricted.

NMFIELD11 TEXT 255 View team ID #.

NMFIELD12 NUMERIC 10 View order.

Fixed weight?

NMFIELD13 NUMERIC 2 1 - Yes;

2 - No (Default).

Indicator weight value.

NMFIELD14 NUMERIC 10 If no value is entered, the system will
consider 1.00 as the weight.

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD14) VALUES (1, 1, 138, 4, 'INDdS',
'Indicator', 'Scorecard Item', 'Scorecard', '2', 'Target Team', 'Measure Team', '2',
'View Team', '1', '2', '1');

Integration guide — SE Suite 2.0

 Integration via database 154

4.6.9.5 - STRSCSUBMETRIC - Sub-indicator import

This import template makes it possible to insert:

§ Scorecard sub-indicators.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 - C ode of component SE Performance.

C ode of the operation to be performed:

FGOPTION X NUMERIC 3
5 - Insert scorecard sub-indicator.

NMFIELD01 X TEXT 255 Upper level indicator ID #.

NMFIELD02 X TEXT 255 Sub-indicator ID #.

View sub-indicator in the tree below the

indicator:
NMFIELD03 NUMERIC 2
1 - Yes;

2 - No.

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 138, 5, 'IND', 'INDSub', '1');

Integration guide — SE Suite 2.0

 Integration via database 155

4.6.9.6 - STRVALUES - Import of target/measurement of

indicators

This import template enables to insert/edit:

§ Indicator target and measurement values.

This import has a particularity, the ADINTERFACE values are saved in the STINTERFACE, where the values are
validated before being inserted into the system. To verify whether the records were accepted in all processes,
access the Target value or Measurement value screen and press the Import button.

To insert each of these items, it is necessary to follow the standard documented below:

Insert/edit

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 – C ode of component SE Performance.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
6 – Insert/Edit values.

NMFIELD01 X TEXT 255 Scorecard indicator ID #.

ID # of the user with permission to import the

NMFIELD02 X TEXT 255
values into the indicators.

ID # of the period for daily, weekly, and bi-weekly

indicators. Values must be entered according to the
indicator frequency.

NMFIELD03 TEXT 255 Frequency: Daily Value: from 1 to 31;

Frequency: Weekly Value: from 1 to 5;

Frequency: Bi-weekly Value: from 1 to 2;

For other frequencies, the values will be NULL.

Integration guide — SE Suite 2.0

 Integration via database 156

ID # of validity PERIOD of the values.

Values must be entered according to the indicator

frequency.

Frequency: Daily, Weekly, Bi-weekly and Monthly

Value: Number of the month (1-Jan, 2-Feb...12-
Dec);

Frequency: Bimonthly Value: Two-month number

NMFIELD04 TEXT 255 (1, 2, 3, 4, 5 or 6);

Frequency: Trimonthly Value: Three-month number

(1, 2, 3 or 4);

Frequency: Quad-monthly Value: Four-month

number (1, 2 or 3);

Frequency: Six-monthly Value: Semester number

(1 or 2);

Frequency: Annually Value: NULL.

ID # of the validity YEAR of the values. The year

NMFIELD05 X TEXT 255 will be represented by 4 numbers. Example: 2010,
2011.

NMFIELD06 TEXT 255 Weight. The default value is 1.

ID # for periods with non-applied values; enter

NMFIELD07 TEXT 255
value 1 for cases of non-applied periods.

NMFIELD08 TEXT 255 Target value.

NMFIELD09 TEXT 255 Measurement value.

NMFIELD10 TEXT 255 Accumulated target value.

NMFIELD11 TEXT 255 Accumulated measurement value.

NMFIELD12 TEXT 255 Value of auxiliary (other) target 1.

NMFIELD13 TEXT 255 Value of auxiliary (other) target 2.

NMFIELD14 TEXT 255 Value of auxiliary (other) target 3.

Example of insertion/editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09) VALUES (1, 1, 138, 6,'IDSCMetric', 'IDUser', '1', '1', '2011', '1', '',
'100 ', '100');

Integration guide — SE Suite 2.0

 Integration via database 157

4.6.9.7 - STRSCORECARD - Import of template-based

Scorecard

This import template enables to create a Scorecard based on a template, which must be created previously

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

performed to:
C DISOSYSTEM X NUMERIC 10
138 – C ode of component SE
Performance.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
7 – Insert Scorecard.

NMFIELD01 X TEXT 255 Scorecard ID #.

NMFIELD02 X TEXT 255 Scorecard name.

NMFIELD03 X TEXT 255 Scorecard template ID #.

Scorecard type ID #.
NMFIELD04 TEXT 255 If null, it will use the scorecard type of the
scorecard template.

Example of a command to insert data via interface:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (1, 1, 138, 7, 'IDSC', 'SCORECARD NAME',
'IDTEMPLATE', 'SCORECARD TYPE ID');

Integration guide — SE Suite 2.0

 Integration via database 158

4.6.9.8 - STRSCORECARDACCESS - Insertion of Scorecard

security

This import template enables to delete the Scorecard access security.

To insert each of these items to the spreadsheet, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 – C ode of component SE Performance

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
8 – Insert Scorecard Security

NMFIELD01 X TEXT 255 Scorecard ID #

Access control type:

1 – Team

2 – Department

NMFIELD02 X NUMERIC 2 3 – Department/Position

4 – Position

5 – User

6 – All

NMFIELD03 x¹ TEXT 255 Department ID #

NMFIELD04 x² TEXT 255 Position ID #

NMFIELD05 x² TEXT 255 User ID # (User ID)

NMFIELD06 x4 TEXT 255 Team ID #

Permission type 1 - Allow; 2 - Deny

NMFIELD07 X NUMERIC 2
Required to Insert Security

Integration guide — SE Suite 2.0

 Integration via database 159

Add/Edit: Access to Add and Edit the

NMFIELD08 x5 NUMERIC 2 Scorecard Structure. Use value 1 to allow
the access to add and edit.

Delete: Access to Delete the Scorecard

NMFIELD09 x5 NUMERIC 2 Structure. Use value 1 to allow the access
to delete.

View: Access to View the Scorecard

NMFIELD10 x5 NUMERIC 2 Structure. Use value 1 to allow the access
to view.

Import: Access to Import all Indicators.

NMFIELD11 x5 NUMERIC 2
Use value 1 to allow the access to import.

§ x¹ – Field must be filled in if the control type is Department.

§ x² – Field must be filled in if the control type is Position.

§ x³ – Field must be filled in if the control type is User.

§ x4 – Field must be filled in if the control type is Team.

§ x5 – At least one of the access securities must be filled in.

Example of a command to insert data via interface:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11) VALUES (1, 1, 138, 8, 'IDSC', 5, 'ID DEPARTMENT',
'ID POSITION', 'ID USER', 'ID TEAM', 1, 1, 1, 1, 1);

Integration guide — SE Suite 2.0

 Integration via database 160

4.6.9.9 - STRDELSCORECARDACCESS - Deletion of Scorecard

security

This import template enables to delete the Scorecard access security.

To insert each of these items to the spreadsheet, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 – C ode of component SE Performance

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
9 – Delete Scorecard Security

NMFIELD01 X TEXT 255 Scorecard ID #

Access type:

1 – Team

2 – Department

3 – Department/Position

4 – Position
NMFIELD02 NUMERIC 2
5 – User

6 – All

If this field is left blank (null), then the

system will delete all Scorecard security
records.

NMFIELD03 x¹ TEXT 255 Department ID #

NMFIELD04 x² TEXT 255 Position ID #

NMFIELD05 x³ TEXT 255 User ID # (User ID)

NMFIELD06 x4 TEXT 255 Team ID #

Integration guide — SE Suite 2.0

 Integration via database 161

§ x¹ – Field must be filled in if the access type is Department.

§ x² – Field must be filled in if the access type is Position.

§ x³ – Field must be filled in if the access type is User.

§ x4 – Field must be filled in if the access type is Team.

Example of a command to delete data via interface:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06) VALUES (1, 1, 138, 9, 'IDSC',
5, 'ID DEPARTMENT', 'ID POSITION', 'ID USER', 'ID TEAM');

Integration guide — SE Suite 2.0

 Integration via database 162

4.6.9.10 - STRSCOREACCESSMTR - Insertion of default

security for Scorecard indicator/element

This import template enables to insert the default access security for Scorecard indicator/element. This security
is only used when the Scorecard is configured to have default security for indicator/element.

To insert each of these items to the spreadsheet, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 – C ode of component SE Performance

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 10 – Insert Scorecard Indicator/Element
Security

NMFIELD01 X TEXT 255 Scorecard ID #

Access control type:

1 – Team

2 – Department

NMFIELD02 X NUMERIC 2 3 – Department/Position

4 – Position

5 – User

6 – All

NMFIELD03 x¹ TEXT 255 Department ID #

NMFIELD04 x² TEXT 255 Position ID #

NMFIELD05 x² TEXT 255 User ID # (User ID)

NMFIELD06 x4 TEXT 255 Team ID #

NMFIELD07 X NUMERIC 2 Permission type 1 - Allow; 2 - Deny

Integration guide — SE Suite 2.0

 Integration via database 163

Alerts: Sending of the Indicator Alert

NMFIELD08 x5 NUMERIC 2 email. Use value 1 to allow the sending of
alerts.

View: View Access use value 1 to allow the

NMFIELD09 x5 NUMERIC 2
view access.

Edit (Details): Access to add/edit on the

Indicator/Element detail screen. Use value
NMFIELD10 x5 NUMERIC 2
1 to allow the access to edit the detail
screen.

Target: Party responsible for entering the

NMFIELD11 x5 NUMERIC 2 Indicator target. Use value 1 to define the
parties responsible for the Indicator target

Measurement: Party responsible for

entering the Indicator measurement. Use
NMFIELD12 x5 NUMERIC 2
value 1 to define the parties responsible
for the Indicator measurement

Responsible: Parties responsible for the

NMFIELD13 x5 NUMERIC 2 indicator information. Use value 1 to define
the parties responsible for the Indicator.

§ x¹ – Field must be filled in if the control type is Department.

§ x² – Field must be filled in if the control type is Position.

§ x³ – Field must be filled in if the control type is User.

§ x4 – Field must be filled in if the control type is Team.

§ x5 – At least one of the access securities must be filled in.

Example of a command to insert data via interface:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12, NMFIELD13) VALUES (1, 1, 138, 10,
'IDSC', 5, 'ID DEPARTMENT', 'ID POSITION', 'ID USER', 'ID TEAM', 1, 1, 1, 1, 1, 1,
1);

Integration guide — SE Suite 2.0

 Integration via database 164

4.6.9.11 - STRDELSCOREACCESSMTR - Deletion of default

security for Scorecard indicator/element

This import template enables to delete the default access security for Scorecard indicator/element.

To insert each of these items to the spreadsheet, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

138 – C ode of component SE Performance

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 11 – Delete Scorecard Indicator/Element
Security

NMFIELD01 X TEXT 255 Scorecard ID #

Access type:

1 – Team

2 – Department

3 – Department/Position

4 – Position
NMFIELD02 NUMERIC 2
5 – User

6 – All

If this field is left blank (null), then the

system will delete all Scorecard
Indicator/Element security records.

NMFIELD03 x¹ TEXT 255 Department ID #

NMFIELD04 x² TEXT 255 Position ID #

NMFIELD05 x³ TEXT 255 User ID # (User ID)

NMFIELD06 x4 TEXT 255 Team ID #

Integration guide — SE Suite 2.0

 Integration via database 165

§ x¹ – Field must be filled in if the access type is Department.

§ x² – Field must be filled in if the access type is Position.

§ x³ – Field must be filled in if the access type is User.

§ x4 – Field must be filled in if the access type is Team.

Example of a command to delete data via interface:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06) VALUES (1, 1, 138, 11,
'IDSC', 5, 'ID DEPARTMENT', 'ID POSITION', 'ID USER', 'ID TEAM');

Integration guide — SE Suite 2.0

 Integration via database 166

4.6.10 - Document

This section contains the following topics:

§ DCACCESS - Access permission to documents

§ DCDOC - Document import

§ DCDOCATR - Attribute import

§ DCDOCATRASS - Attribute association import

§ DCDOCATRVAL - Import of attribute values

§ DCDOCCANCEL - Document cancellation

§ DCDOCCOMP - Import of complementary documents

§ DCDOCELEC - Import of electronic file of documents

§ DCDOCREV - Document revision import

§ DCDOCREVPAR - Import of revision participants

Integration guide — SE Suite 2.0

 Integration via database 167

4.6.10.1 - DCACCESS - Access permission to documents

This import template makes it possible to insert:

§ Access permission to a document.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 - C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
6 - Import of access rights.

NMFIELD01 X TEXT 255 Document ID #.

Access type:

1 - Group of users (Team);

2 - Department;

NMFIELD02 X TEXT 255 3 - Department/Position;

4 - Position;

5 - User;

6 - All.

Permission type:

1 - Allow;
NMFIELD03 TEXT 255
2 - Deny.

(If not entered, the default value is 1)

Integration guide — SE Suite 2.0

 Integration via database 168

Permissions:

1 - Acknowledgment;

2 - Training;

3 - View;

4 - Edit;

5 - Delete;

6 - Print;

7 - Archive;

8 - Revise;

9 - Distribute copy;
NMFIELD04 TEXT 255
X 10 - C reate training;

11- C ancel;

12 - Save locally;

13 - Sign;

14 - Notification;

15 - Add comments;

16 - Evaluate applicability.

These values may be combined, separated

by commas. Example: 3, 4, 5, 11 (View,
Edit, Delete, and C ancel accesses).

Department ID # (Required depending on

NMFIELD05 TEXT 255
the access type [NMFIELD02]).

Position ID # (Required depending on the

NMFIELD06 TEXT 255
access type [NMFIELD02]).

User login (Required depending on the

NMFIELD07 TEXT 255
access type [NMFIELD02]).

User group ID # (Required depending on

NMFIELD08 TEXT 255
the access type [NMFIELD02]).

NMFIELD09 X TEXT 255 C ategory ID #.

Upper level interface code. If the upper

NMFIELD75 TEXT 255 level interface is not imported successfully,
the current interface will not be executed.

Example of the function to insert an access permission:

INSERT INTO ADINTERFACE(CDINTERFACE, CDISOSYSTEM, FGIMPORT,FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES(1, 73, 1, 6, 'TR000005', '6', '1',
'1,2,3,4,5,6,7,8,9,10,11,12,13,14,15');

Integration guide — SE Suite 2.0

 Integration via database 169

4.6.10.2 - DCDOC - Document import

This import template makes it possible to insert:

§ Data of a document

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 - C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
1 - Inserts a new document.

Document ID # (if not entered, an ID # will be

NMFIELD01 TEXT 255
created automatically).

NMFIELD02 X TEXT 255 C ategory ID #.

NMFIELD03 X TEXT 255 Document title.

Name of the document author (if not entered,

NMFIELD04 TEXT 255
the record user will be used).

Inherit category access:

1 - Inherit;
NMFIELD05 TEXT 255
2 - Do not inherit.

(if not entered, 1 - Inherit will be used)

NMFIELD06 TEXT 255 Revision date (Format: yyyy-mm-dd).

NMFIELD07 X TEXT 255 Recorded user ID #.

NMFIELD08 TEXT 255 First revision ID #.

NMFIELD09 TEXT 255 Allows importing documents being indexed.

Integration guide — SE Suite 2.0

 Integration via database 170

Note: only for documents whose category has

no revision control. (enter value 1)

Upper level interface code. If the upper level

NMFIELD75 TEXT 255 interface is not imported successfully, the
current interface will not be executed.

DSFIELD01 TEXT 4000 Document summary.

Example of the function to insert a document:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
DSFIELD01) VALUES (1, 73, 1, 1, 'TR000005', 'TR', 'SoftExpert Excellence Suite -
Integration architecture', 'Diego Silveira', '1', '2009-07-07', 'SILVEIRA', 'A',
'Interface documentation');

Integration guide — SE Suite 2.0

 Integration via database 171

4.6.10.3 - DCDOCATR - Attribute import

This import template makes it possible to insert:

§ Data of an attribute.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 - C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
96 - Inserts a new attribute.

NMFIELD01 X TEXT 255 Attribute ID #.

NMFIELD02 X TEXT 255 Attribute name.

NMFIELD03 X TEXT 255 User ID #.

Attribute type:

1 - List of values;
NMFIELD04 X TEXT 255
2 - Non-discrete;

3 - External.

Integration guide — SE Suite 2.0

 Integration via database 172

Attribute data type.

List of values:

1 - Text;

2 - Numeric;

3 - Date;

5 - C urrency.

Non-discrete
NMFIELD05 TEXT 255
1 - Text;

2 - Numeric;

3 - Date;

4 - Memo;

5 - C urrency.

External

1 - Text.

Selection mode.

List of values and External attribute types

must inform the Selection mode. Accepted
values:

1 - Zoom;
NMFIELD06 TEXT 255
2 - C ombo.

The List of values attribute type can inform

whether the attribute will be Multivalued.
Accepted values:

1 - Multivalued.

NMFIELD07 TEXT 255 Multivalued.

Upper level interface code. If the upper

NMFIELD75 TEXT 255 level interface is not imported successfully,
the current interface will not be executed.

Example of the function to insert attributes:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07) VALUES (01, 73, 1,
96, 'LDATA', 'Data List', 'Peter',’1’,’3’,’2’);

Integration guide — SE Suite 2.0

 Integration via database 173

4.6.10.4 - DCDOCATRASS - Attribute association import

This import template makes it possible to insert:

§ Data of an attribute association.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 – C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
94 – Inserts a new attribute association.

NMFIELD01 X TEXT 255 Document ID #.

NMFIELD02 X TEXT 255 Attribute ID #.

Attribute value.

Standards to enter date type data:

X TEXT 255
NMFIELD03 § dd/mm/yyyy;

§ yyyy-mm-dd.

Revision ID #.

Required information if the component

NMFIELD04 X TEXT 255
needs the revision code in the specific
table of the attribute.

NMFIELD05 X TEXT 255 C ategory ID #.

If the value 1 is entered, The interface will

verify whether the attribute value already
NMFIELD10 TEXT 255
belongs to the list of values; if it does not
exist, it will be added.

DSFIELD01 X TEXT 4000 Attribute value.

Integration guide — SE Suite 2.0

 Integration via database 174

Mandatory information if the type of the

attribute value is MEMO.

Upper level interface code. If the upper

NMFIELD75 TEXT 255 level interface is not imported successfully,
the current interface will not be executed.

Example of the function to insert attribute associations:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (1, 73, 1, 94, 'POP000001', 'WEIGHT', '120
Kg', '00');

Integration guide — SE Suite 2.0

 Integration via database 175

4.6.10.5 - DCDOCATRVAL - Import of attribute values

This import template makes it possible to insert:

§ Data of an attribute value.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 - C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
95 - Inserts a new attribute value.

NMFIELD01 X TEXT 255 Attribute ID #.

Attribute value.

Required information if the attribute type is

NMFIELD02 X TEXT 255
List of values. Non-discrete type attributes
will not be accepted for value import.

Use as default.

1 - The value of the attribute will be the

X TEXT 255 default for the attribute.
NMFIELD03
2 - The value of the attribute will not be
the default for the attribute.

NMFIELD04 X TEXT 255 User ID #.

Server (the name or the IP address of the

NMFIELD05 TEXT 255
external attribute database).

NMFIELD06 TEXT 255 Alias/Database path (external attribute).

NMFIELD07 TEXT 255 Database user (external attribute).

Integration guide — SE Suite 2.0

 Integration via database 176

NMFIELD08 TEXT 255 Password (external attribute).

DB type.

1 - ITERBASE

2 - MSSQL

3 - MSSQL (ODBC )

4 - ORAC LE < 8.05

5 - ORAC LE 8/9 (SERVIC E NAME)

NMFIELD09 TEXT 255 6 - ORAC LE 8/9 (SID)

7 - ORAC LE (ODBC )

8 - DB2 (ODBC )

9 - INFORMIX

10 - ORAC LE 8/9 (TNS NAME)

11 - MySQL

12 - POSTGRESQL

SQL (Select that will search for the

NMFIELD10 TEXT 255
external attribute field).

Field.

NMFIELD11 TEXT 255 Standards to enter date type data:

· yyyy-mm-dd.

Upper level interface code. If the upper

NMFIELD75 TEXT 255 level interface is not imported successfully,
the current interface will not be executed.

Example of the function to insert attribute values:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11) VALUES (01, 73, 1, 95, 'LDATA', 'Data List', '1',
'DES145', 'Peter', 'BDORACLE',’th01’,’1’,’ORACLE’,’’ ,’’);

Integration guide — SE Suite 2.0

 Integration via database 177

4.6.10.6 - DCDOCCANCEL - Document cancellation

This import template enables to cancel:

§ Document

To insert each of these items, it is necessary to follow the standard documented below.

Cancel

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 - C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
8 - Document cancellation.

NMFIELD01 X TEXT 255 Document ID #.

NMFIELD02 X TEXT 255 C ancellation responsibility ID #.

NMFIELD03 X TEXT 255 C ategory ID #.

Upper level interface code. If the upper level

NMFIELD75 TEXT 255 interface is not imported successfully, the current
interface will not be executed.

DSFIELD01 X TEXT 4000 Explanation for document cancellation.

Cancellation example:

INSERT INTO ADINTERFACE(CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD75, DSFIELD01)
VALUES (1, 1, 73, 8, 'DOC000001', '0110', 'DOC', NULL, 'Obsolete document');

Integration guide — SE Suite 2.0

 Integration via database 178

4.6.10.7 - DCDOCCOMP - Import of complementary

documents

This import template makes it possible to insert:

§ Association of complementary documents.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 - C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
7 - Import of complementary documents.

NMFIELD01 X TEXT 255 Upper level document ID #.

NMFIELD02 X TEXT 255 Upper level document revision ID #.

NMFIELD03 X TEXT 255 Upper level document category ID #.

NMFIELD04 X TEXT 255 Lower level document ID #.

NMFIELD05 X TEXT 255 Lower level document revision ID #.

NMFIELD06 X TEXT 255 Lower level document category ID #.

Upper level interface code. If the upper

NMFIELD75 TEXT 255 level interface is not imported successfully,
the current interface will not be executed.

Integration guide — SE Suite 2.0

 Integration via database 179

Example of the function to insert a complementary document:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (1, 73, 1, 7, 'TR000005', '02', 'TR000001',
'00');

Integration guide — SE Suite 2.0

 Integration via database 180

4.6.10.8 - DCDOCELEC - Import of electronic file of

documents

This import template makes it possible to insert:

§ Data of an electronic file of a document.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 - C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
97 - Inserts a new electronic file.

NMFIELD01 X TEXT 255 Document ID #.

NMFIELD02 X TEXT 255 Revision ID #.

File name. Add the extension.

NMFIELD03 X TEXT 255
E.g.: Document.doc

NMFIELD04 TEXT 255 User ID #.

Electronic file directory (the NMFIELD05 or

NMFIELD05 TEXT 255
FLFIELD01 field must be filled in).

Electronic file compression type.

0 - Uncompressed file.
NMFIELD06 TEXT 255
1 - GZ compression.

2 - ZIP compression.

NMFIELD07 X TEXT 255 C ategory ID #.

Integration guide — SE Suite 2.0

 Integration via database 181

Upper level interface code. If the upper

NMFIELD75 TEXT 255 level interface is not imported successfully,
the current interface will not be executed.

FLFIELD01 FILE Electronic file association.

Example of the function to insert an electronic file of a document:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, FLFIELD01)
VALUES (1, 73, 1, 97, 'TR000005', '* TH0017', 'CGQ Manual of Quality.doc',
'THIAGO01', 'C:\REPOSITORIO01\CGQMANUALOFQUALITY.DOC', '0', '');

Integration guide — SE Suite 2.0

 Integration via database 182

4.6.10.9 - DCDOCREV - Document revision import

This import template makes it possible to insert:

§ Data of a document revision.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 - C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
99 - Inserts a new revision.

NMFIELD01 X TEXT 255 Document ID #.

NMFIELD02 X TEXT 255 ID # of the user who created the revision.

Revision ID # (if not entered, a new ID # will be

TEXT 255
NMFIELD03 created).

Revision route ID #. Required information

NMFIELD04 TEXT 255
according to the revision route configuration.

Revision date. If not entered, the dates will be

the current date.
NMFIELD05 TEXT 255
Standards to enter date type data:

§ yyyy-mm-dd.

Scheduled start date. If not entered, the dates

will be the current date.
NMFIELD06 TEXT 255
Standards to enter date type data:

§ yyyy-mm-dd.

Integration guide — SE Suite 2.0

 Integration via database 183

Revision generation date. If not entered, the

dates will be the current date.
NMFIELD07 TEXT 255
Standards to enter date type data:

§ yyyy-mm-dd.

NMFIELD08 TEXT 255 Revision reason ID #.

Scheduled end date.

NMFIELD09 TEXT 255 Standards to enter date type data:

§ yyyy-mm-dd.

Actual start date.

NMFIELD10 TEXT 255 Standards to enter date type data:

§ yyyy-mm-dd.

Actual end date.

NMFIELD11 TEXT 255 Standards to enter date type data:

§ yyyy-mm-dd.

Optional. To change the title of the document of

NMFIELD12 TEXT 255
the new revision.

Optional. To change the ID # of the document of

NMFIELD13 TEXT 255
the new revision.

Optional. To change the author of the document

NMFIELD14 TEXT 255
of the new revision.

Optional. To enter the end of the revision.

NMFIELD15 TEXT 255
(Enter value 1)

NMFIELD16 X TEXT 255 C ategory ID #.

Upper level interface code. If the upper level

NMFIELD75 TEXT 255 interface is not imported successfully, the current
interface will not be executed.

DSFIELD01 TEXT 4000 Revision reason.

DSFIELD02 TEXT 4000 Revision description.

Optional. To change the summary of the

DSFIELD03 TEXT 4000
document of the new revision.

Integration guide — SE Suite 2.0

 Integration via database 184

Example of the function to insert a document revision:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, DSFIELD01, DSFIELD02) VALUES (1, 73, 1, 99,
'TR000005', 'THIAGO01', '02', 'Route 01', '2009-07-07', '2009-07-07', '2009-07-07',
'01', '2009-07-07', '2009-07-07', '2009-07-07',’Document is out of date’,’New
Revision of Document’);

Integration guide — SE Suite 2.0

 Integration via database 185

4.6.10.10 - DCDOCREVPAR - Import of revision participants

This import template makes it possible to insert:

§ Data of a document revision participant.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

73 - C ode of component SE Document.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
98 - Inserts a new revision participant.

NMFIELD01 X TEXT 255 Document ID #.

C ontrol type: Mandatory field(s):

1 - Team NMFIELD06

2 - Department NMFIELD07

NMFIELD02 X TEXT 255 3 - NMFIELD07/

Department/Positi NMFIELD08
on

4 - Position NMFIELD08

5 - User NMFIELD09

Revision step.

Possible values:

1 - Draft;
X TEXT 255
NMFIELD03 2 - Review;

3 - Approval;

4 - Release.

Integration guide — SE Suite 2.0

 Integration via database 186

NMFIELD04 X TEXT 255 Participant sequence.

NMFIELD05 X TEXT 255 Participant deadline in days.

NMFIELD06 TEXT 255 Team ID #.

NMFIELD07 TEXT 255 Department ID #.

NMFIELD08 TEXT 255 Position ID #.

NMFIELD09 TEXT 255 User ID #.

Participant revision approval ID #.

1 – Approved;
NMFIELD10 TEXT 255
2 – Rejected.

Required to fill in NMFIELD11.

Revision approval/rejection date.

NMFIELD11 TEXT 255
Required to fill in NMFIELD10.

NMFIELD12 X TEXT 255 C ategory ID #.

NMFIELD13 X TEXT 255 Revision ID #.

Upper level interface code. If the upper

NMFIELD75 TEXT 255 level interface is not imported successfully,
the current interface will not be executed.

Example of the function to insert document revision participants:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09) VALUES (1, 73, 1, 98, '* TH0017', '5', '1', '1', '1', '', '', '',
'THIAGO01');

Integration guide — SE Suite 2.0

 Integration via database 187

4.6.11 - Inspection

This section contains the following topics:

§ IPCFG - Inspection configuration

§ IPCFGCAR - Characteristic relationship in inspection configuration

§ IPCFGCKL – Checklist relationship in inspection configuration

§ IPIQS - Evaluation indexes

§ IPQUAL - Import of inspection qualifications

§ IPREC - Import of receiving

Integration guide — SE Suite 2.0

 Integration via database 188

4.6.11.1 - IPCFG - Inspection configuration

This import template enables to insert/edit/delete:

§ Inspection form data

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

34 – C ode of component SE Inspection.

C ode of the operation to be performed:

14 – Insert;
FGOPTION X NUMERIC 2
15 – Edit;

16 – Delete.

NMFIELD01 X1 TEXT 255 Inspection form type ID #.

NMFIELD02 X TEXT 255 Inspection form ID #.

NMFIELD03 X1 TEXT 255 Item/Supply ID #.

NMFIELD04 X1 TEXT 255 Item/Supply revision ID #.

NMFIELD05 X1 TEXT 255 Process ID #

NMFIELD06 X1 TEXT 255 Process revision ID #.

NMFIELD07 X1 TEXT 255 Process activity ID #.

NMFIELD08 X2 TEXT 255 Evaluation group name.

NMFIELD09 X2 TEXT 255 Quality index ID #.

NMFIELD10 TEXT 255 Allow editing the receiving flow:

Integration guide — SE Suite 2.0

 Integration via database 189

1 – Allow;

2 – Do not allow (default option).

NMFIELD11 X3 TEXT 255 Inspection flow ID #

Block receiving for this inspection form:

NMFIELD12 TEXT 255 1 – Block;

2 – Do not block (default option).

Frequency type:

1 – Uncontrolled;
NMFIELD13 X4 TEXT 255 2 – Execution date;

3 – Inspect an instance every... (only available

when there are processes involved).

NMFIELD14 X5 TEXT 255 Frequency/Number of instances.

Frequency unit:

1 – Days;

NMFIELD15 X5 TEXT 255 2 – Weeks;

3 – Months;

4 – Years.

NMFIELD16 X5 TEXT 255 Date of the next execution.

NMFIELD17 X5 TEXT 255 Responsible team.

NMFIELD18 X6 TEXT 255 Inspection frequency.

NMFIELD19 X6 TEXT 255 Skip-lot type name.

NMFIELD20 X6 TEXT 255 Frequency sequence of the selected skip-lot.

C ontrol initial sample:

NMFIELD21 TEXT 255 1 – Yes;

2 – No (default option).

Sample status:

1 – Blocked;
NMFIELD22 X7 TEXT 255
2 – Initial sample;

3 – Released.

NMFIELD23 X7 TEXT 255 Deadline.

C ontrol initial sampling validity:

NMFIELD24 TEXT 255 1 – Yes;

2 – No (default option).

Integration guide — SE Suite 2.0

 Integration via database 190

NMFIELD25 X8 TEXT 255 Initial sampling validity frequency.

Initial sampling validity frequency unit

1 – Days;

NMFIELD26 X8 TEXT 255 2 – Weeks;

3 – Months;

4 – Inspections.

DSFIELD01 TEXT 4000 Initial sampling comments.

Register averages/readings:

NMFIELD27 X2 TEXT 255 1 – Register averages;

2 – Register readings.

Rule:

1 – Sampling plan;

NMFIELD28 X9 TEXT 255 2 – Sampling table;

3 – Defined size;

4 – Percentage.

Sampling plan:

1 – Simple;
NMFIELD29 X9 TEXT 255
2 – Double;

3 – Multiple.

Inspection level:
NMFIELD30 X9 TEXT 255 The available options are the same as the values
displayed on the inspection form data screen.

Work regime:

1 – Reduced;
NMFIELD31 X9 TEXT 255
2 – Normal;

3 – Tightened.

NQA:
NMFIELD32 X9 TEXT 255 The available options are the same as the values
displayed on the inspection form data screen.

NMFIELD33 X9 TEXT 255 Sampling table ID #.

NMFIELD34 X9 TEXT 255 Sample size.

Fixed sample size:

NMFIELD35 X9 TEXT 255 1 – Yes;

2 – No (default option).

Integration guide — SE Suite 2.0

 Integration via database 191

NMFIELD36 X9 TEXT 255 Number/Maximum percentage of rejects.

NMFIELD37 X9 TEXT 255 Percentage.

§ X 1 – Required when adding; ignored for other actions

§ X 2 – Mandatory when adding, optional while editing and deleting

§ X 3 – Required if it does not allow editing the inspection flow

§ X 4 – Required when adding if the form object type allows the frequency to be controlled

§ X 5 – Required when adding if the frequency is controlled

§ X 6 – Required when adding if the form object type requires the inspection frequency to be entered

§ X 7 – Required when adding if the form object type requires the inspection frequency to be entered and the option to
control the initial sample is active

§ X 8 – Required when adding if the form object type requires the inspection frequency to be entered and the option to
control the initial sample and the validity are active.

§ X 9 – Required if the form object type requires filling out a sampling plan and the option of the sampling rule requires it
to be filled in.

Example of insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD08, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD27, NMFIELD28) VALUES (11, 1, 14, 34, 'Raw-material', 'SUPPLY000001', '001',
'0', 'Appraisers', '01', '2', 'DP', 1, 1);

Example of editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD02,

NMFIELD11) VALUES (12, 1, 15, 34, 'SUPPLY000001', NULL);

Example of deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD02)

VALUES (12, 1, 16, 34, 'SUPPLY000001');

Integration guide — SE Suite 2.0

 Integration via database 192

4.6.11.2 - IPCFGCAR - Characteristic relationship in

inspection configuration

This import template enables to associate/edit/disassociate:

§ Inspection form characteristic data.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

34 – C ode of component SE Inspection.

C ode of the operation to be performed:

20 – Insert characteristic;
FGOPTION X NUMERIC 2
21 – Edit characteristic;

22 – Delete characteristic.

NMFIELD01 X TEXT 255 Inspection form ID #.

NMFIELD02 X TEXT 255 C haracteristic ID #.

Required:

NMFIELD03 TEXT 255 1 – Required (default option);

2 – Not required.

NMFIELD04 X1 TEXT 255 Validity.

Frequency unit:

1 – Days;

NMFIELD05 X1 TEXT 255 2 – Weeks;

3 – Months;

4 – Inspections.

NMFIELD06 TEXT 255 Add characteristic to the inspection report

Integration guide — SE Suite 2.0

 Integration via database 193

1 – Yes;

2 – No (default option).

Register averages/readings:

NMFIELD07 X2 TEXT 255 1 – Register averages;

2 – Register readings.

Rule:

1 – Sampling plan;

NMFIELD08 X3 TEXT 255 2 – Sampling table;

3 – Defined size;

4 – Percentage.

Sampling plan:

1 – Simple;
NMFIELD09 X3 TEXT 255
2 – Double;

3 – Multiple.

Inspection level:
NMFIELD10 X3 TEXT 255 The available options are the same as the values
displayed on the inspection form data screen.

Work regime:

1 – Reduced;
NMFIELD11 X3 TEXT 255
2 – Normal;

3 – Tightened.

NQA:
NMFIELD12 X3 TEXT 255 The available options are the same as the values
displayed on the inspection form data screen.

NMFIELD13 X3 TEXT 255 Sampling table ID #.

NMFIELD14 X3 TEXT 255 Sample size.

Fixed sample size:

NMFIELD15 X3 TEXT 255 1 – Yes;

2 – No (default option).

NMFIELD16 X3 TEXT 255 Number/Maximum percentage of rejects.

NMFIELD17 X3 TEXT 255 Percentage.

§ X 1 – Required when adding if the “Required” option is disabled.

§ X 2 – Required when adding, optional while editing/deleting.

§ X 3 – Required if the selected sampling type option requires filling the field in.

Integration guide — SE Suite 2.0

 Integration via database 194

Example of association:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD07, NMFIELD08, NMFIELD17, NMFIELD16) VALUES (1, 1, 20, 34,
'ITPROC0001', 'SEMI01', '1', '4', '6', '6');

Example of editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD17, NMFIELD16) VALUES (2, 1, 21, 34, 'ITPROC0001', 'SEMI01', '5',
'5');

Example of disassociation:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD17, NMFIELD16) VALUES (2, 1, 22, 34, 'ITPROC0001', 'SEMI01');

Integration guide — SE Suite 2.0

 Integration via database 195

4.6.11.3 - IPCFGCKL – Checklist relationship in inspection

configuration

This import template enables to associate/disassociate:

§ Inspection form checklists

To insert each of these items, it is necessary to follow the standard documented below.

Association

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

34 – C ode of component SE Inspection.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 25 – Associate checklist;

26 – Disassociate checklist.

NMFIELD01 X TEXT 255 Inspection form ID #.

NMFIELD02 X TEXT 255 C hecklist ID #.

Example of association:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (1, 1, 25, 34, 'ITPROC0001', 'CKL0001');

Example of disassociation:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02) VALUES (1, 1, 26, 34, 'ITPROC0001', 'CKL0001');

Integration guide — SE Suite 2.0

 Integration via database 196

4.6.11.4 - IPIQS - Evaluation indexes

This import template enables to insert/edit/delete:

§ Index evaluation data

To insert each of these items, it is necessary to follow the standard documented below.

Inserts an evaluation index reading

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

34 – C ode of component SE Inspection.

C ode of the operation to be performed:

11 – Add;
FGOPTION X NUMERIC 2 12 – Edit;

13 – Delete (only the last evaluation may be

deleted).

NMFIELD01 X TEXT 255 Evaluation type ID #.

NMFIELD02 X1 TEXT 255 Object ID # (item/supply)

NMFIELD03 X1 TEXT 255 Supplier company ID.

NMFIELD04 X2 TEXT 255 Evaluation due date.

NMFIELD05 X TEXT 255 Evaluation score value.

NMFIELD06 X1 TEXT 255 Process ID #

NMFIELD07 X1 TEXT 255 Process activity ID #.

DSFIELD01 TEXT 4000 Evaluation comments.

Integration guide — SE Suite 2.0

 Integration via database 197

§ X 2 – Required for inspections where Object, Process, Process activity, or Supplier is part of the evaluation; otherwise,
they will be ignored.

§ X 2 – Required when adding and editing.

Example of addition:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 11, 34, 'QIDX000001',
'IT000001', 'SUPPLIER00001', '01/01/2015', '100');

Example of editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (9, 1, 12, 34, 'QIDX000001',
'IT000001', 'SUPPLIER00001', '01/01/2015', '95');

Example of deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (10, 1, 13, 34, 'QIDX000001', 'IT000001',
'SUPPLIER00001');

Integration guide — SE Suite 2.0

 Integration via database 198

4.6.11.5 - IPQUAL - Import of inspection qualifications

This import template enables to edit:

§ Receiving data in the qualification step.

To insert each of these items, it is necessary to follow the standard documented below.
Insert/edit/delete inspection qualification index

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

34 - C ode of component SE Inspection.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
10 – Edit.

NMFIELD01 X TEXT 255 Receiving ID # (number).

NMFIELD02 X TEXT 255 Qualification index name.

NMFIELD03 X TEXT 255 Qualification index option name.

Send to next step:

1 – Send to the next step;

NMFIELD04 TEXT 255 2 – Do not send to the next step.

The record will only be sent to the next step if all

index items are entered.

DSFIELD01 TEXT 4000 Qualification index item comments.

Example to update the qualification of a receiving:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (4, 1, 10, 34, '000001', 'Punctuality', 'On
time', 'Comments');

Integration guide — SE Suite 2.0

 Integration via database 199

4.6.11.6 - IPREC - Import of receiving

This import template enables to insert/edit/send to next step/delete:

§ Receiving data

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete receiving

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

34 – C ode of component SE Inspection.

C ode of the operation to be performed:

3 – Add;
FGOPTION X NUMERIC 2
4 – Edit;

5 – Delete.

NMFIELD01 X1 TEXT 255 Inspection form ID #

NMFIELD02 X2 TEXT 255 Supplier company ID.

NMFIELD03 X3 TEXT 255 Lot number

NMFIELD04 X3 TEXT 255 Invoice number

NMFIELD05 X3 TEXT 255 Invoice date

NMFIELD06 X3 TEXT 255 Order number

NMFIELD07 X3 TEXT 255 Order date

NMFIELD08 X3 TEXT 255 Request order number

NMFIELD09 X3 TEXT 255 Request order date

NMFIELD10 X3 TEXT 255 Production order number

NMFIELD11 X3 TEXT 255 Production order date

Integration guide — SE Suite 2.0

 Integration via database 200

NMFIELD12 X3 TEXT 255 Estimated date

NMFIELD13 X3 TEXT 255 Actual date

NMFIELD14 X3 TEXT 255 Expected amount

NMFIELD15 X3 TEXT 255 Actual quantity

NMFIELD16 X3 TEXT 255 Estimated cost

NMFIELD17 X3 TEXT 255 Actual cost

NMFIELD18 X4 TEXT 255 Inspection flow ID #

Send to the next step (only for editing):

NMFIELD19 TEXT 255 1 – Send to the next step;

2 – Do not send to the next step.

NMFIELD20 X5 TEXT 255 Workflow instance ID #

NMFIELD21 X6 TEXT 255 Receiving ID # (number)

NMFIELD22 X3 TEXT 255 Estimated time

NMFIELD23 X3 TEXT 255 Actual time

NMFIELD24 TEXT 255 Description

§ X 1 – Required when adding; ignored for other actions.

§ X 2 – Required for inspections of Supplies, Services, and External finished products; ignored for other object types.

§ X 3 – Required, not required, or ignored, depending on the configurations set in the inspection form type.

§ X 4 – Required if the "Allow editing flow during receiving" option is checked in the inspection form, or ignored otherwise.

§ X 5 – Required if the inspection object is a Workflow process instance; ignored otherwise.

§ X 6 – Required for the change and deletion.

Example of addition:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD12, NMFIELD13, NMFIELD14, NMFIELD15) VALUES (1, 1, 3, 34,
'IP0001', 'SUPPLIER001', '2015-01-01', '2015-01-01', 1000, 1000);

Example of editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD21,

NMFIELD15, NMFIELD19) VALUES (2, 1, 4, 34, '000001', 123, 1);

Integration guide — SE Suite 2.0

 Integration via database 201

Example of deletion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD21)

VALUES (2, 1, 4, 34, '000001');

Integration guide — SE Suite 2.0

 Integration via database 202

4.6.12 - Supply

This section contains the following topics:

§ INSATTR - Association of attributes with the supply

§ INSINS - Supply import

§ INSINSSTR - Supply structure import

§ INSTYPE - Supply type import

Integration guide — SE Suite 2.0

 Integration via database 203

4.6.12.1 - INSATTR - Association of attributes with the

supply

This import template enables to import attributes into supply records and to determine their values.

To insert each of these items, it is necessary to follow the standard documented below:

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

149 - C ode of component SE Supply.

C ode of the operation to be performed:

14 – Inserts a new attribute association. If the

FGOPTION X NUMERIC 2
attribute is already associated, it only updates its
value.

NMFIELD01 X TEXT 255 Supply ID #.

NMFIELD02 X TEXT 255 Attribute ID #.

Attribute value. Standards to enter date type data:

NMFIELD03 X TEXT 255 § dd/mm/yyyy;

§ yyyy-mm-dd.

NMFIELD04 TEXT 255 Revision ID #.

If the value 1 is entered, The interface will verify

NMFIELD10 TEXT 255 whether the attribute value already belongs to the
list of values; if it does not exist, it will be added.

Attribute value. Mandatory information if the type

DSFIELD01 TEXT 4000
of the attribute value is MEMO.

Integration guide — SE Suite 2.0

 Integration via database 204

Example:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04)
VALUES (1, 1, 14, 149, 'INS01','Diameter', '1/4', '00');

Integration guide — SE Suite 2.0

 Integration via database 205

4.6.12.2 - INSINS - Supply import

This import template enables to insert, update, or delete:

§ Supply definition.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

149 - C ode of component SE Supply.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 1 - Insert supply; if it exists, edits it;

2 – Delete supply.

Supply ID # (for deletion only this field is

NMFIELD01 X TEXT 255
required).

NMFIELD02 X TEXT 255 Supply name.

NMFIELD03 X
1 TEXT 255 Supply type (ID #).

NMFIELD04 X TEXT 255 Responsible team (ID #).

NMFIELD05 TEXT 255 C ost.

NMFIELD06 X TEXT 255 Measurement unit (ID #).

Example of the function to insert a supply:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06) VALUES (1, 149, 1, 1,
‘SUP01’, ‘Screw’, ‘INS’, ‘Team 01’, ‘1.00’, ‘un’);

Integration guide — SE Suite 2.0

 Integration via database 206

4.6.12.3 - INSINSSTR - Supply structure import

This import template enables to insert, update, or delete:

§ Supply in the structure.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

149 - C ode of component SE Supply.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 3 - Add supply to the structure; if it exists, edits it;

4 - Remove supply from the structure;

NMFIELD01 X TEXT 255 Upper level supply ID # (parent supply).

NMFIELD02 X TEXT 255 Upper level supply revision ID # (parent supply).

NMFIELD03 X TEXT 255 Supply ID # (lower level supply).

NMFIELD04 X TEXT 255 Supply revision ID # (lower level supply).

NMFIELD05 X TEXT 255 Quantity.

Example of the function to insert a supply to the structure:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (2, 149, 1, 3, ‘SUP01’, ‘01’,
‘SUP02’, ‘00’, 5);

Integration guide — SE Suite 2.0

 Integration via database 207

4.6.12.4 - INSTYPE - Supply type import

This import template enables to insert, update, or delete:

§ Supply type.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

149 – C ode of component SE Supply.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 7 – Insert supply type; if it exists, edits it;

8 – Delete supply type;

Supply type ID # (for deletion, only this field is

NMFIELD01 X TEXT 255
required).

NMFIELD02 X TEXT 255 Supply type name.

NMFIELD03 TEXT 255 Upper level supply type (ID #).

NMFIELD04 TEXT 255 Identification mask (ID #).

Allow editing the ID # generated by the

identification mask (required if the option to use

NMFIELD05 TEXT 255 identification mask is equal to 1):

1 – Yes;

2 – No.

Revision control:

NMFIELD06 X TEXT 255 1 – Yes;

2 – No.

Integration guide — SE Suite 2.0

 Integration via database 208

Revision template:

1 – ISO9000 based;
NMFIELD07 TEXT 255
2 – Workflow.

Required in the case of revision

Route type:

1 – Fixed;

NMFIELD08 TEXT 255 2 – Variable;

3 – Fixed & unique.

Required in the case of revision

Revision route (ID #):

NMFIELD09 TEXT 255 Revised if the revision template is ISO9000 and the
route type is “fixed & unique”

Process (ID #):

NMFIELD10 TEXT 255
Required if the revision template is WORKFLOW.

Revision ID #:

1 – Numeric;

NMFIELD11 TEXT 255 2 – Text;

3 – C ustomized.

Required in the case of revision

C ycle:

1 – Numeric;
NMFIELD12 TEXT 255
2 – Text.

Required in the case of revision

NMFIELD13 TEXT 255 Retention of obsolete revisions – Quantity.

Retention of obsolete revisions – Frequency unit:

1 – Revisions;
NMFIELD14 TEXT 255
2 – Months;

3 – Years.

C hange:

1 – Text;
NMFIELD15 TEXT 255
2 – Numeric.

Required in the case of revision

ISO9000 configuration – Approval mode:

1 – Incremental;
NMFIELD16 TEXT 255
2 – C ircular.

Required if the revision template is ISO9000.

Integration guide — SE Suite 2.0

 Integration via database 209

ISO9000 configuration – C losure:

1 – Automatic;
NMFIELD17 TEXT 255
2 – Manual.

Required if the revision template is ISO9000.

ISO9000 configuration – Draft:

1 – AND;
NMFIELD18 TEXT 255
2 – OR.

Required if the revision template is ISO9000.

ISO9000 configuration – Review:

1 – AND;
NMFIELD19 TEXT 255
2 – OR.

Required if the revision template is ISO9000.

ISO9000 configuration – Approval:

1 – AND;
NMFIELD20 TEXT 255
2 – OR.

Required if the revision template is ISO9000.

ISO9000 configuration – Release:

1 – AND;
NMFIELD21 TEXT 255
2 – OR.

Required if the revision template is ISO9000.

Begin filling in the explanation when starting a

revision

NMFIELD22 TEXT 255 1 – Yes;

2 – No.

Required in the case of revision

Example of the function to insert a supply type with no revision:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06) VALUES (1, 149, 1, 7, ‘Type
01’, ‘Office supplies’, NULL, NULL, NULL, 2);

Integration guide — SE Suite 2.0

 Integration via database 210

4.6.13 - Maintenance

This section contains the following topics:

§ MNMAINTCORRECT – Corrective maintenance import

§ MNMAINTMETER – Meter reading

§ MNMAINTVARIABLE – Variable reading

Integration guide — SE Suite 2.0

 Integration via database 211

4.6.13.1 - MNMAINTCORRECT – Corrective maintenance

import

This import template makes it possible to insert:

§ Data of a corrective maintenance.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete asset

Column Required Type Precision Description

Sequential code - Identifies an item

C DINTERFAC E X NUMERIC 10
to be imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration

will be performed to:
C DISOSYSTEM X NUMERIC 10
126 – C ode of component SE
Maintenance.

C ode of the operation to be

FGOPTION X NUMERIC 2 performed:

1 – C reate a corrective maintenance.

Activity ID # (Generated
NMFIELD01 X TEXT 255
automatically if not entered).

NMFIELD02 X TEXT 255 Standard activity ID #.

NMFIELD03 X TEXT 255 Asset ID #.

NMFIELD04 X1 TEXT 255 Execution start date.

NMFIELD05 X1 TEXT 255 Execution start time.

NMFIELD06 X1 TEXT 255 Actual percentage (%).

NMFIELD07 X2 TEXT 255 Service center ID #.

Responsible technician:

NMFIELD08 X2 TEXT 255 § Internal service center: User ID.

§ Third-party service center: Name

Integration guide — SE Suite 2.0

 Integration via database 212

Maintenance attributes. Example:

identifier_of_attribute1=valued_of_att
ribute1;

Example with a multivalued attribute:

identifier_of_attribute1=value1_of_att
ribute1,value2_of_attribute1,value3_
DSFIELD01 X3 TEXT 4000 of_attribute1.

Note: For attributes with numeric

value, the decimal place separator
must be ’.’. For date fields, the value
must have the “Y-M-D”(Year-Month-
Day) format

§ X¹ - Required if the "Start date", "Start time" and/or "Actual percentage" field(s) is(are) filled in

§ X² - Required if it is not entered in the standard activity

§ X³ - Required if the standard activity has a required attribute

Example of addition:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
DSFIELD01) VALUES (1,126,1,1, 'Activity','Standard
activity','Asset','01/01/1111','11:11', '100','Service center','Responsible
technician', 'identifier_attribute1=value_attribute1');

Integration guide — SE Suite 2.0

 Integration via database 213

4.6.13.2 - MNMAINTMETER – Meter reading

This import template makes it possible to insert:

§ Asset meter readings

To insert each of these items, it is necessary to follow the standard documented below.

Insert Reading

Column Required Type Precision Description

Sequential code - Identifies an item

C DINTERFAC E X NUMERIC 10
to be imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration

will be performed to:
C DISOSYSTEM X NUMERIC 10
126 – C ode of the SE Maintenance
component

C ode of the operation to be

FGOPTION X NUMERIC 2 performed:

2 – Insert meter reading

NMFIELD01 X TEXT 255 Asset ID #.

Action. List of options:

NMFIELD02 X TEXT 255 1 – New meter reading
2 – New meter restarter

Reading value.

Use point as decimal separator and

NMFIELD03 X¹ TEXT 255
do not used thousands separator, for
example “16000.000”.

Meter reading date, in the format

mm/dd/YYYY.
NMFIELD04 TEXT 255
If empty, it will consider the date and
time of the import service.

Integration guide — SE Suite 2.0

 Integration via database 214

Meter reading time, in the format

hh:mm (00:00 - 23:59). If empty, it
NMFIELD05 X² TEXT 255
will consider the date and time of the
import service.

X¹ - Required if the action is New meter reading. Not required if the action is New meter restart.

X¹ - Required if the reading date is filled in.

Example of meter reading insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 126, 2, 'AT-0001', '1',
'1300.000', NULL, NULL);

Example of meter restarter insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 126, 2, 'AT-0001', '2',
NULL, '01/15/2016', '15:30');

Integration guide — SE Suite 2.0

 Integration via database 215

4.6.13.3 - MNMAINTVARIABLE – Variable reading

This import template makes it possible to insert:

§ Asset variable readings

To insert each of these items, it is necessary to follow the standard documented below.

Insert Reading

Column Required Type Precision Description

Sequential code - Identifies an item

C DINTERFAC E X NUMERIC 10
to be imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration

will be performed to:
C DISOSYSTEM X NUMERIC 10
126 – C ode of the SE Maintenance
component

C ode of the operation to be

FGOPTION X NUMERIC 2 performed:

3 – Insert variable reading

NMFIELD01 X TEXT 255 Asset ID #.

NMFIELD02 X TEXT 255 Variable ID #.

If it is a subjective variable:

Name of the option of the list of

values of the variable.

NMFIELD03 X TEXT 255 If it is an objective variable:

Reading value.

Use point as decimal separator and

do not used thousands separator, for
example “16000.000”.

Variable reading date, in the format

mm/dd/YYYY.
NMFIELD04 TEXT 255
If empty, it will consider the date and
time of the import service.

Integration guide — SE Suite 2.0

 Integration via database 216

Variable reading time, in the hh:mm

(00:00 - 23:59) format. If empty, it
NMFIELD05 X¹ TEXT 255
will consider the date and time of the
import service.

X¹ - Required if the reading date is filled in.

Example of variable reading insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 126, 3, 'AT-0001', 'VAR-
0001', '1300.000', NULL, NULL);

Integration guide — SE Suite 2.0

 Integration via database 217

4.6.14 - PDM

This section contains the following topics:

§ ITATTR - Association of attributes with the item

§ ITBOM - Item structure import

§ ITCARATR - Import of attribute type characteristics

§ ITCARTPAT - Import of the asset type association with the item characteristics

§ ITCARVAR - Import of variable type characteristics

§ ITCUST - Item X customer association import

§ ITDOCASSOC - Association of documents with the item record

§ ITITEM - Item import

§ ITMANU - Item X manufacturer association import

§ ITSECU - Item type security import

§ ITSUPP - Item X supplier association import

§ ITTYPE - Import of item types

Integration guide — SE Suite 2.0

 Integration via database 218

4.6.14.1 - ITATTR - Association of attributes with the item

This import template enables to import attributes into the item records and to determine their values.

To insert each of these items, it is necessary to follow the standard documented below:

ITATTR – Association of attributes with the item

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

14 – Inserts a new attribute association. If

FGOPTION X NUMERIC 2
the attribute is already associated, it only
updates its value.

NMFIELD01 X TEXT 255 Item ID #.

NMFIELD02 X TEXT 255 Attribute ID #.

Attribute value.

Standards to enter date type data:

NMFIELD03 X TEXT 255
§ dd/mm/yyyy;

§ yyyy-mm-dd.

NMFIELD04 TEXT 255 Revision ID #.

If the value 1 is entered. The interface will

verify whether the attribute value already
NMFIELD10 TEXT 255
belongs to the list of values; if inexistent, it
will be added.

Attribute value.
DSFIELD01 TEXT 4000 Required information if the type of the
attribute value is MEMO

Integration guide — SE Suite 2.0

 Integration via database 219

Example:

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (1, 107, 1, 14, 'IT001','Voltage', '110v',

'00');

Integration guide — SE Suite 2.0

 Integration via database 220

4.6.14.2 - ITBOM - Item structure import

This import template enables to insert/edit/delete:

§ Data of the structure of an item.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete item structure

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

3 - Insert item into the structure. If it

FGOPTION X NUMERIC 2
exists, edits it;

4 - Delete item from the structure.

NMFIELD01 X TEXT 255 Upper level item (parent item) ID #.

Upper level item (parent item) revision ID

NMFIELD02 X TEXT 255
#.

NMFIELD03 X TEXT 255 Item (lower level item) ID #.

NMFIELD04 TEXT 255 Item (lower level item) revision ID #.

X

NMFIELD05 X TEXT 255 Quantity used in the structure.

Object specification (C onsidered as 1 by

default):
NMFIELD06 TEXT 255
1 - Item;

2 - Supply.

Integration guide — SE Suite 2.0

 Integration via database 221

Example of insertion/editing/deletion of item structure:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 3, 107, 'CPU', '01', 'Ram
memory', '01', '1');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (2, 1, 3, 107, 'CPU', '01', 'Ram
memory', '01', '2');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04) VALUES (3, 1, 4, 107, 'CPU', '01', 'Ram memory',
'01');

Integration guide — SE Suite 2.0

 Integration via database 222

4.6.14.3 - ITCARATR - Import of attribute type

characteristics

This import template enables to insert and/or edit attribute type characteristics.

To insert each of these items, it is necessary to follow the standard documented below:

ITCARATR – Import of attribute type characteristics

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

15 – Only inserts;

16 – Only edits;
FGOPTION X NUMERIC 2
17 – Insert and, if there is already a
record with the same ID #, edits the
existing record.

NMFIELD01 X TEXT 255 Item ID #.

NMFIELD02 X TEXT 255 Item revision ID #.

NMFIELD03 X TEXT 255 C haracteristic ID #.

NMFIELD04 X TEXT 255 C haracteristic name.

NMFIELD05 TEXT 255 C haracteristic type ID #.

Special characteristic:

NMFIELD06 TEXT 255 1 – Yes;

2 – No.

C ustomer symbol name Required if the

NMFIELD07 TEXT 255
characteristic is special.

Supplier symbol name Required if the

NMFIELD08 TEXT 255
characteristic is special.

Integration guide — SE Suite 2.0

 Integration via database 223

DSFIELD01 TEXT 4000 C omments.

DSFIELD02 TEXT 4000 Specifications.

Example:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
DSFIELD01, DSFIELD02) VALUES (1, 107, 1, 15, 'IT001', '00', 'RE', 'Roughness
(Electronic)', '1', 'CR', 'CR', 'Evaluate roughness according to specifications',
'Technical specifications X = 15º / 12,6 mm');

Integration guide — SE Suite 2.0

 Integration via database 224

4.6.14.4 - ITCARTPAT - Import of the asset type association

with the item characteristics

This import template enables to associate the asset type with the characteristic records in the item.

To insert each of these items, it is necessary to follow the standard documented below:

ITCARTPAT – Import of the asset type association with the item characteristics

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will

C DISOSYSTEM X NUMERIC 10 be performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
22 – Associate.

NMFIELD01 X TEXT 255 Item ID #.

NMFIELD02 X TEXT 255 Item revision ID #.

NMFIELD03 X TEXT 255 C haracteristic ID #.

NMFIELD04 X TEXT 255 Asset type ID #.

Integration guide — SE Suite 2.0

 Integration via database 225

4.6.14.5 - ITCARVAR - Import of variable type

characteristics

This import template enables to insert and/or edit variable type characteristics:

To insert each of these items, it is necessary to follow the standard documented below:

ITCARVAR – Import of variable type characteristics

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

18 – Only inserts;

19 – Only edits;
FGOPTION X NUMERIC 2
20 – Insert and, if there is already a
record with the same ID #, edits the
existing record.

NMFIELD01 X TEXT 255 Item ID #.

NMFIELD02 X TEXT 255 Item revision ID #.

NMFIELD03 X TEXT 255 C haracteristic ID #.

NMFIELD04 X TEXT 255 C haracteristic name.

NMFIELD05 TEXT 255 C haracteristic type ID #.

Special characteristic:

NMFIELD06 TEXT 255 1 – Yes;

2 – No.

C ustomer symbol name Required if the

NMFIELD07 TEXT 255
characteristic is special.

Supplier symbol name Required if the

NMFIELD08 TEXT 255
characteristic is special.

Integration guide — SE Suite 2.0

 Integration via database 226

NMFIELD09 X TEXT 255 Number of decimal places.

Limits:

0 – Bilateral;
NMFIELD10 X TEXT 255
1 – Unilateral up;

2 – Unilateral down.

NMFIELD11 X TEXT 255 Measurement unit ID #.

NMFIELD12 X TEXT 255 Nominal value.

NMFIELD13 X TEXT 255 Upper tolerance.

NMFIELD14 X TEXT 255 Lower tolerance.

DSFIELD01 TEXT 4000 C omments.

Example:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD14, DSFIELD01) VALUES
(1, 107, 1, 15, 'IT001', '00', 'RE', 'Roughness (Electronic)', '1', 'CR', 'CR', '2',
'1', '1,00', '-1,00', 'Evaluate roughness according to specifications');

Integration guide — SE Suite 2.0

 Integration via database 227

4.6.14.6 - ITCUST - Item X customer association import

This import template enables to insert/edit/delete:

§ Data of the association between item and customers.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete association between item and customers

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

5 - Insert/Edit association of customers

FGOPTION X NUMERIC 2 with items;

6 - Delete association of customers with

items.

NMFIELD01 X1 TEXT 255 Item ID #.

NMFIELD02 X2 TEXT 255 C ustomer company ID.

NMFIELD03 X3 TEXT 255 C ustomer company name.

NMFIELD04 TEXT 255 C ustomer item #.

NMFIELD05 TEXT 255 C ustomer revision #.

NMFIELD06 TEXT 255 C ustomer drawing #.

NMFIELD07 TEXT 255 C ustomer drawing date.

NMFIELD10 X4 TEXT 255 C ompany code.

Integration guide — SE Suite 2.0

 Integration via database 228

X 1 - Field required for deletion.

X 2- Field required if “C ompany code” is empty (valid also for deletion).

X 3- Field required if “C ompany code” is empty (valid also for deletion).

X 4 - Field required if “C ompany ID” and/or “C ompany name” are empty (valid also for deletion).

Example of insertion/editing/deletion of association between item and customers:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07) VALUES (1, 1, 5,
107, 'Software PDM', 'SoftExpert', 'SOFTEXPERT SOFTWARE S.A.', 'XX001', '1.11',
'N/A', '01/08/2009');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07) VALUES (2, 1, 5,
107, 'Software PDM', 'SoftExpert', 'SOFTEXPERT SOFTWARE S.A.', 'XX001', '1.12',
'N/A', '01/02/2010');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (3, 1, 6, 107, 'Software PDM', 'SoftExpert',
'SOFTEXPERT SOFTWARE S.A.');

Integration guide — SE Suite 2.0

 Integration via database 229

4.6.14.7 - ITDOCASSOC - Association of documents with the

item record

This import template enables to insert/edit:

§ Associate documents saved in SE Document with an item record in SE PDM.

See below the interface details:

ITDOCASSOC – Association of documents with the item record

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 21 – Associates the document with the
item.

NMFIELD01 X TEXT 255 Item ID #.

NMFIELD02 X TEXT 255 Item revision ID #.

NMFIELD03 X TEXT 255 Document ID #.

NMFIELD04 X TEXT 255 Document revision ID #.

NMFIELD05 X TEXT 255 Document category ID #.

Example:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 107, 1, 15, 'IT001','00',
'PRO2012-0001', '00', 'PRO');

Integration guide — SE Suite 2.0

 Integration via database 230

4.6.14.8 - ITITEM - Item import

This import template enables to insert/edit/delete:

§ Data of an item:

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete item

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 1 - Insert item; if it exists, edits it;

2 - Delete item.

Item ID # (only field required for

NMFIELD01 X TEXT 255
deletion).

NMFIELD02 X TEXT 255 Item name.

NMFIELD03 X TEXT 255 Item type ID #.

NMFIELD04 TEXT 255 Responsible team ID #.

X

NMFIELD05 X TEXT 255 Measurement unit ID #.

Physical state:

1 – Solid;

NMFIELD06 TEXT 255 2 – Liquid;

3 – Gas;

4 – Sludge.

NMFIELD07 TEXT 255 Odor ID #.

Integration guide — SE Suite 2.0

 Integration via database 231

NMFIELD08 TEXT 255 C olor name.

NMFIELD09 TEXT 255 UN code.

NMFIELD10 TEXT 255 Hazard ID #.

NMFIELD11 TEXT 255 C lassification ID #.

NMFIELD12 TEXT 255 ABNT code.

DSFIELD01 TEXT 4000 General description of the composition.

Example of insertion/editing/deletion of items:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, DSFIELD01)
VALUES (1, 1, 1, 107, 'EB000001', 'Engine block V12', 'Engines', 'Project team',
'pt', '1', '001', 'Green', '15122', 'PL001', 'CL003', 'Description in the associated
document');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, DSFIELD01)
VALUES (2, 1, 1, 107,'EB000001', 'Engine block V12', 'Engines', 'Manufacturing
team', 'pt', '1', '001', 'Green', '15122', 'PL001', 'CL003', 'Description in the
associated document');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (3, 1, 2, 107, 'EB000001');

Integration guide — SE Suite 2.0

 Integration via database 232

4.6.14.9 - ITMANU - Item X manufacturer association import

This import template enables to insert/edit/delete:

§ Data of the association between item and manufacturers.

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit/delete association between item and manufacturers

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

7 – Insert/Edit association of
FGOPTION X NUMERIC 2 manufacturers with items;

8 – Delete association of manufacturers

with items.

NMFIELD01 X1 TEXT 255 Item ID #.

NMFIELD02 X2 TEXT 255 C ustomer company ID.

NMFIELD03 X3 TEXT 255 C ustomer company name.

NMFIELD04 X TEXT 255 Manufacturer reference.

NMFIELD05 X TEXT 255 Template.

NMFIELD10 X4 TEXT 255 C ompany code.

X 1 - Field required for deletion.

X 2 - Field required if “C ompany code” is empty. (also valid for deletion).

X 3 - Field required if “C ompany code” is empty. (also valid for deletion).

Integration guide — SE Suite 2.0

 Integration via database 233

X 4 - Field required if “C ompany ID” and/or “C ompany name” are empty. (also valid for deletion).

Example of insertion/editing/deletion of association between item and manufacturers:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 1, 7, 107, 'Software PDM',
'SoftExpert', 'SOFTEXPERT SOFTWARE S.A.', 'SE PDM', '1.10');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (2, 1, 7, 107, 'Software PDM',
'SoftExpert', 'SOFTEXPERT SOFTWARE S.A.', 'SE PDM', '1.11');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (3, 1, 8, 107, 'Software PDM',
'SoftExpert', 'SOFTEXPERT SOFTWARE S.A.');

Integration guide — SE Suite 2.0

 Integration via database 234

4.6.14.10 - ITSECU - Item type security import

This import template makes it possible to insert:

§ Data of the item type security.

To insert each of these items, it is necessary to follow the standard documented below.

Insert item type security data

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 13 - Insert security control for the item
type.

NMFIELD01 X TEXT 255 Item type ID #.

Permission group type:

1 - Team;

2 - Department;

NMFIELD02 X TEXT 255 3 - Department/Position;

4 - Position;

5 - User;

6 - All.

C ontrol to add:

NMFIELD03 X TEXT 255 1 - Yes;

2 - No.

C ontrol to edit:

NMFIELD04 TEXT 255 1 - Yes;

X
2 - No.

Integration guide — SE Suite 2.0

 Integration via database 235

C ontrol to delete:

NMFIELD05 X TEXT 255 1 - Yes;

2 - No.

Security data control:

NMFIELD06 X TEXT 255 1 - Yes;

2 - No.

C ontrol to list:

NMFIELD07 X TEXT 255 1 - Yes;

2 - No.

C ontrol to view:

NMFIELD08 X TEXT 255 1 - Yes;

2 - No.

Permission:

NMFIELD09 X TEXT 255 1 - Allow;

2 - Deny.

Access type ID #.

Example: If the type is by user, it will be

NMFIELD10 TEXT 255
the user ID. If the type is by department,
it will be the department ID #.

Position ID #. This field will only be used if

the type is by department and position.
NMFIELD11 TEXT 255 That way, the department will go in the
NMFIELD10 field and the position, in this
one.

Example of insertion of security for item type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06 , NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11) VALUES (1, 1, 12, 107, 'Engine block', '1', '1',
'1', '1', '1', '1', '1', '1', 'Team 01', '');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06 , NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11) VALUES (2, 1, 12, 107, 'Engine block', '4', '1',
'1', '1', '1', '1', '1', '1', 'Department 01', 'Position 01');

Integration guide — SE Suite 2.0

 Integration via database 236

4.6.14.11 - ITSUPP - Item X supplier association import

This import template enables to insert/edit/delete:

§ Data of the association between item and supplier.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

9 - Insert/Edit association of suppliers with the

FGOPTION X NUMERIC 2
items;

10 - Delete association of suppliers with the items.

NMFIELD01 X TEXT 255 Item ID # (field required for deletion).

C ustomer company ID. Field required if “C ompany

NMFIELD02 TEXT 255
code” is empty. (also valid for deletion).

C ustomer company name. Field required if

NMFIELD03 TEXT 255
“C ompany code” is empty. (also valid for deletion).

NMFIELD04 X TEXT 255 Supplier reference.

NMFIELD05 X TEXT 4000 Description.

NMFIELD06 TEXT 255 Minimum reorder quantity.

NMFIELD07 TEXT 4000 Expected delivery (quantity).

Integration guide — SE Suite 2.0

 Integration via database 237

Expected delivery unit:

1 - Day;

NMFIELD08 TEXT 255 2 - Week;

3 - Month;

4 - Year.

NMFIELD09 TEXT 4000 C ost.

C ompany code. Required field if “C ompany ID”

NMFIELD10 TEXT 4000 and/or “C ompany name” are empty.

(also valid for deletion)

Example of insertion/editing/deletion of the association between item and suppliers:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09)
VALUES (1, 1, 9, 107, 'Software PDM', 'SoftExpert', 'SOFTEXPERT SOFTWARE S.A.', 'SE
PDM', 'Product life cycle management software', '1', '15', '1', '3000' );

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09)
VALUES (2, 1, 9, 107, 'Software PDM', 'SoftExpert', 'SOFTEXPERT SOFTWARE S.A.', 'SE
PDM', 'Product life cycle management software', '1', '15', '1', '2500' );

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05)
VALUES (3, 1, 10, 107,'Software PDM', 'SoftExpert', 'SOFTEXPERT SOFTWARE S.A.');

Integration guide — SE Suite 2.0

 Integration via database 238

4.6.14.12 - ITTYPE - Import of item types

This import template enables to insert/edit/delete:

§ Data of an item type.

To insert each of these items, it is necessary to follow the standard documented below.

ITTYPE - Insert/edit/delete item type

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

107 - C ode of component SE PDM.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2 11 - Insert item type; if it exists, edits it;

12 - Delete item type.

Item type ID # (for deletion, only this field

NMFIELD01 X TEXT 255
is required).

NMFIELD02 X TEXT 255 Item type name.

NMFIELD03 TEXT 255 Upper level item type.

Use identification mask:

NMFIELD04 TEXT 255 1 - Yes;

X
2 - No.

Identification mask ID # (required if the

NMFIELD05 TEXT 255 option to use identification mask is equal
to 1).

Allow editing the ID # generated by the

identification mask (required if the option

NMFIELD06 TEXT 255 to use identification mask is equal to 1):

1 - Yes;

2 - No.

Integration guide — SE Suite 2.0

 Integration via database 239

Revision control:

NMFIELD07 X TEXT 255 1 - Yes;

2 - No.

Revision ID # (required if the option to

control the revision is equal to 1):

NMFIELD08 TEXT 255 1 - Numeric;

2 - Text;

3 - C ustomized.

Approval method (required if the option to

control the revision is equal to 1):
NMFIELD09 TEXT 255
1 - Incremental;

2 - C ircular.

C losure (required if the option to control

the revision is equal to 1):
NMFIELD10 TEXT 255
1 - Automatic;

2 - Manual.

Number of retentions of obsolete revisions

NMFIELD11 TEXT 255 (required if the option to control the
revision is equal to 1);

Retention frequency (required if the option

to control the revision is equal to 1):

NMFIELD12 TEXT 255 1 - Revisions;

2 - Months;

3 - Years.

Route type (required if the option to

control the revision is equal to 1):
NMFIELD13 TEXT 255
1 - Fixed;

2 - Variable.

Acceptance of revision draft (required if

the option to control the revision is equal

NMFIELD14 TEXT 255 to 1):

1 - AND;

2 - OR.

Acceptance of review revision (required if

the option to control the revision is equal

NMFIELD15 TEXT 255 to 1):

1 - AND;

2 - OR.

Integration guide — SE Suite 2.0

 Integration via database 240

Acceptance of approval revision (required

if the option to control the revision is equal

NMFIELD16 TEXT 255 to 1):

1 - AND;

2 - OR.

Acceptance of Release revision (required if

the option to control the revision is equal

NMFIELD17 TEXT 255 to 1):

1 - AND;

2 - OR.

Watermark:

NMFIELD18 X TEXT 255 1 - Yes;

2 - No.

Publish PDF files:

NMFIELD19 X TEXT 255 1 - Yes;

2 - No.

File type:

1 - Simple;
NMFIELD20 X TEXT 255
2 - Multiple;

3 - C omplex.

C omplex file container ID # (required if

NMFIELD21 TEXT 255
the file type option is equal to 3).

Example of insertion/editing/deletion of item types:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD18, NMFIELD19, NMFIELD20, NMFIELD21) VALUES (1, 1, 11, 107, 'Engine block',
'Engine block', '', '2', '', '', '2', '1', '1', '2', '');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD18, NMFIELD19, NMFIELD20, NMFIELD21) VALUES (1, 1, 11, 107, 'Engine block',
'Engine block', '', '2', '', '', '2', '1', '1', '3', 'Container SW');

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, FGOPTION, CDISOSYSTEM, NMFIELD01)

VALUES (3, 1, 12, 107, 'Engine block');

Integration guide — SE Suite 2.0

 Integration via database 241

4.6.15 - Project

This section contains the following topics:

§ PROFINANCE - Financial import

§ PRORESOURCE - Resource value import

§ PROTIME - Timesheet import

Integration guide — SE Suite 2.0

 Integration via database 242

4.6.15.1 - PROFINANCE - Financial import

This template enables financial imports in SE Suite.

To insert this item, it is necessary to follow the standard documented below:

Insert

Column Required Type Precision Description

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

41 - C ode of component SE Project.

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

FGOPTION X NUMERIC 2 Record option, it will always have 2.

Operation to be performed:

NMFIELD01 X NUMERIC 2 1 - Add;

2 - Edit

FGIMPORT X NUMERIC 2 If the record was already imported.

NMFIELD02 X TEXT 255 Projects/Nonproject task ID #.

Project task ID #.
X TEXT 255
NMFIELD03 (Will only be validated if it is a project).

Identifies whether the financial record is from a

project task or from a nonproject task:

1 - Project task;
NMFIELD04 X NUMERIC 2
2 - Project;

3 - Nonproject task;

4 - Program;

Financial entry type:

NMFIELD05 X NUMERIC 2 1 - C ost;
2 - Revenue;

NMFIELD06 X TEXT 255 C ost or revenue name.

NMFIELD07 X TEXT 255 C ost or revenue type (Financial type).

NMFIELD08 NUMERIC 10 Document number.

C ost or revenue actual date. Date format:

NMFIELD09 X TEXT 255
DD/MM/YYYY or YYYY-MM-DD.

Integration guide — SE Suite 2.0

 Integration via database 243

NMFIELD10 X NUMERIC 10 C ost or revenue unit amount.

NMFIELD11 X NUMERIC 10 C ost or revenue unit value.

DSFIELD01 TEXT 255 C ost description for the task.

Execution date. Date format: DD/MM/YYYY or YYYY-

DTEXEC UTION TEXT 255
MM-DD.

DSERROR TEXT 255 Error description.

Import type:
1 - Planning;
NMFIELD12 X NUMERIC 2
2 - Re-planning;
3 - Actual.

NMFIELD22 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD22

NMFIELD23 TEXT 255
field.

NMFIELD24 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD24

NMFIELD25 TEXT 255
field.

NMFIELD26 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD26

NMFIELD27 TEXT 255
field.

NMFIELD28 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD28

NMFIELD29 TEXT 255
field.

NMFIELD30 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD30

NMFIELD31 TEXT 255
field.

NMFIELD32 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD32

NMFIELD33 TEXT 255
field.

NMFIELD34 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD34

NMFIELD35 TEXT 255
field.

NMFIELD36 TEXT 255 Attribute ID #.

Integration guide — SE Suite 2.0

 Integration via database 244

Value of the attribute specified in the NMFIELD36

NMFIELD37 TEXT 255
field.

NMFIELD38 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD38

NMFIELD39 TEXT 255
field.

NMFIELD40 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD40

NMFIELD41 TEXT 255
field.

NMFIELD42 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD42

NMFIELD43 TEXT 255
field.

NMFIELD44 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD44

NMFIELD45 TEXT 255
field.

NMFIELD46 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD46

NMFIELD47 TEXT 255
field.

NMFIELD48 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD48

NMFIELD49 TEXT 255
field.

NMFIELD50 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD50

NMFIELD51 TEXT 255
field.

NMFIELD52 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD52

NMFIELD53 TEXT 255
field.

NMFIELD54 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD54

NMFIELD55 TEXT 255
field.

NMFIELD56 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD56

NMFIELD57 TEXT 255
field.

NMFIELD58 TEXT 255 Attribute ID #.

Integration guide — SE Suite 2.0

 Integration via database 245

Value of the attribute specified in the NMFIELD58

NMFIELD59 TEXT 255
field.

NMFIELD60 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD60

NMFIELD61 TEXT 255
field.

NMFIELD62 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD62

NMFIELD63 TEXT 255
field.

NMFIELD64 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD64

NMFIELD65 TEXT 255
field.

NMFIELD66 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD66

NMFIELD67 TEXT 255
field.

NMFIELD68 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD68

NMFIELD69 TEXT 255
field.

NMFIELD70 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD70

NMFIELD71 TEXT 255
field.

NMFIELD72 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD72

NMFIELD73 TEXT 255
field.

NMFIELD74 TEXT 255 Attribute ID #.

Value of the attribute specified in the NMFIELD74

NMFIELD75 TEXT 255
field.

The values accepted for the import of dates must follow one of the following standards:

§ YYYY-MM-DD

§ DD/MM/YYYY

Example: Insert a cost into a project task:

Integration guide — SE Suite 2.0

 Integration via database 246

Planning:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04 ) VALUES (41,8,2,1,1,'PROJECT','1',1,'COST
TYPE1','CT1','2010-07-08',12,125,1,1);

Re-planning:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04 ) VALUES (41,7,2,1,1,'PROJECT','1', 1,'COST
TYPE2','CT2','2010-07-12',21,47,2,1);

Actual:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04 ) VALUES (41,9,2,1,1,'PROJECT','1',1,'COST
TYPE3','CT3','2010-07-21',2,2107,3,1);

Example: Insert a cost into a project task:

Planning:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04 ) VALUES (41,11,2,1,1,'PROJECT','1',2,'REVENUE
TYPE1','RT1','2010-07-08', 12,125,1,1);

Re-planning:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04 ) VALUES (41,10,2,1,1,'PROJECT','1', 2,'REVENUE
TYPE2','RT2','2010-07-12', 21,47,2,1);

Integration guide — SE Suite 2.0

 Integration via database 247

Actual:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10,
NMFIELD11, NMFIELD12, NMFIELD04 ) VALUES (41,12,2,1,1,'PROJECT','1',2,'REVENUE
TYPE3','RT3','2010-07-21', 2,2107,3,1);

Example: Insert a cost into a nonproject task:

Planning:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04 ) VALUES (41,2,2,1,1,'NONPROJECT TASK',1,'COST
TYPE1','CT1','2010-07-08', 2,125,1,3);

Re-planning:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04 ) VALUES (41,1,2,1,1,'NONPROJECT TASK',1,'COST
TYPE2','CT2','2010-07-12', 2,27,2,3);

Actual:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04 ) VALUES (41,3,2,1,1,'NONPROJECT TASK',1,'COST
TYPE3','CT3','2010-07-21', 2,207,3,3);

Example: Insert a cost into a nonproject task:

Planning:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04 ) VALUES (41,5,2,1,1,'NONPROJECT TASK',2,'REVENUE
TYPE1','RT1','2010-07-08', 2,125,1,3);

Integration guide — SE Suite 2.0

 Integration via database 248

Re-planning:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04 ) VALUES (41,4,2,1,1,'NONPROJECT TASK',2,'REVENUE
TYPE2','RT2','2010-07-12', 2,27,2,3);

Actual:

INSERT INTO ADINTERFACE ( CDISOSYSTEM, CDINTERFACE, FGOPTION, FGIMPORT, NMFIELD01,

NMFIELD02, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD09, NMFIELD10, NMFIELD11,
NMFIELD12, NMFIELD04 ) VALUES (41,6,2,1,1,'NONPROJECT TASK',2,'REVENUE
TYPE3','RT3','2010-07-21', 2,207,3,3);

Integration guide — SE Suite 2.0

 Integration via database 249

4.6.15.2 - PRORESOURCE - Resource value import

This import template enables to insert/edit:

§ Resource values;

To insert each of these items, it is necessary to follow the standard documented below.

Add/edit resource values

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error.

System code where the integration will be performed

C DISOSYSTEM X NUMERIC 10 to:

41 – C ode of component SE Project.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
3 – Insert resource value.

NMFIELD01 X TEXT 255 Resource ID # or name.

NMFIELD02 X TEXT 255 C alendar ID # or name.

C ost date – Date in format DD/MM/YYYY or YYYY-

NMFIELD03 TEXT 255 MM-DD. Required to create a new cost range. Field
NULL represents the initial range of the cost.

C ost - regular working hour value. Required to

NMFIELD04 TEXT 255 create a new cost range for a Work or Asset
resource type.

C ost – overtime rate. Required to create a new cost

NMFIELD05 TEXT 255
range for the Labor resource type.

C ost – weekend rate. Required to create a new cost

NMFIELD06 TEXT 255
range for the Labor resource type.

C ost - percentage value. Required to create a new

NMFIELD07 TEXT 255
cost range for the Asset resource type.

Billing date – Date in format DD/MM/YYYY or YYYY-

NMFIELD08 TEXT 255
MM-DD. Required to create a new billing range. Field

Integration guide — SE Suite 2.0

 Integration via database 250

NULL represents the initial range of the billing.

Billing – regular working hour value. Required to

NMFIELD09 TEXT 255 create a new billing range for the Work or Asset
resource type.

Billing – overtime rate. Required to create a new

NMFIELD10 TEXT 255
billing range for the Labor resource type.

Billing – weekend rate. Required to create a new

NMFIELD11 TEXT 255
billing range for the Labor resource type.

Billing – daily rate. Required to create a new billing

NMFIELD12 TEXT 255
range for the Asset resource type.

Example of insertion/editing of resource values:

Calendar association and initial values of the cost and the billing for the Labor resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (1, 1, 41, 3, 'User', 'Calendar',
NULL, '1', '2', '2', NULL, NULL, '4', '6', '4', NULL);

Inserting/updating a cost for a Labor resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (2, 1, 41, 3, 'User', 'Calendar',
'2010-01-01', '1', '2', '2', NULL, NULL, NULL, NULL, NULL, NULL);

Inserting/Updating a billing for a Labor resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (3, 1, 41, 3, 'User', 'Calendar',
NULL, NULL, NULL, NULL, NULL, '2010-01-01', '4', '6', '4', NULL);

Integration guide — SE Suite 2.0

 Integration via database 251

Association of the calendar and initial value of the cost and the billing for the Asset resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (1, 1, 41, 3, 'User', 'Calendar',
NULL, '1', NULL, NULL, '2', NULL, '4', NULL, NULL, '6');

Inserting/updating a cost for an Asset resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (2, 1, 41, 3, 'User', 'Calendar',
'2010-01-01', '1', NULL, NULL, '2', NULL, NULL, NULL, NULL, NULL);

Inserting/updating a billing to an Asset resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (3, 1, 41, 3, 'User', 'Calendar',
NULL, NULL, NULL, NULL, NULL, '2010-01-01', '4', NULL, NULL, '6');

Associating a calendar for a Work or Asset resource type:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12) VALUES (4, 1, 41, 3, 'User', 'Calendar',
NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);

Integration guide — SE Suite 2.0

 Integration via database 252

4.6.15.3 - PROTIME - Timesheet import

This import template enables to insert/edit:

§ Timesheet;

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit timesheet

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

41 - C ode of component SE Project.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
1 - Insert timesheet.

NMFIELD01 X TEXT 255 Object ID #.

NMFIELD02 X TEXT 255 Activity ID #.

NMFIELD03 TEXT 255 Task WBS.

Timesheet date. Date format:

NMFIELD04 TEXT 255
X DD/MM/YYYY or YYYY-MM-DD.

Timesheet start time. Required if total is

NMFIELD05 X TEXT 255
not entered.

Timesheet end time. Required if total is not

NMFIELD06 X TEXT 255
entered.

Timesheet total time. Required if start and

NMFIELD07 X TEXT 255
end time are not entered.

Hour type:

NMFIELD08 X TEXT 255 1 - Regular hour;

2 - Overtime.

Integration guide — SE Suite 2.0

 Integration via database 253

NMFIELD09 X TEXT 255 Resource ID # or name.

Task type:

1 - Project task;

2 - Nonproject task;

NMFIELD10 X TEXT 255 3 - Monitored event.

4 - Meeting;

5 - Isolated action;

6 - Action plan action.

NMFIELD22 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD23 TEXT 255
NMFIELD22 field.

NMFIELD24 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD25 TEXT 255
NMFIELD24 field.

NMFIELD26 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD27 TEXT 255
NMFIELD26 field.

NMFIELD28 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD29 TEXT 255
NMFIELD28 field.

NMFIELD30 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD31 TEXT 255
NMFIELD30 field.

NMFIELD32 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD33 TEXT 255
NMFIELD32 field.

NMFIELD34 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD35 TEXT 255
NMFIELD34 field.

NMFIELD36 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD37 TEXT 255
NMFIELD36 field.

NMFIELD38 TEXT 255 Attribute ID #.

Integration guide — SE Suite 2.0

 Integration via database 254

Value of the attribute specified in the

NMFIELD39 TEXT 255
NMFIELD38 field.

NMFIELD40 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD41 TEXT 255
NMFIELD40 field.

NMFIELD42 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD43 TEXT 255
NMFIELD42 field.

NMFIELD44 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD45 TEXT 255
NMFIELD44 field.

NMFIELD46 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD47 TEXT 255
NMFIELD46 field.

NMFIELD48 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD49 TEXT 255
NMFIELD48 field.

NMFIELD50 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD51 TEXT 255
NMFIELD50 field.

NMFIELD52 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD53 TEXT 255
NMFIELD52 field;

NMFIELD54 TEXT 255 Attribute ID #;

Value of the attribute specified in the

NMFIELD55 TEXT 255
NMFIELD54 field.

NMFIELD56 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD57 TEXT 255
NMFIELD56 field.

NMFIELD58 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD59 TEXT 255
NMFIELD58 field.

Integration guide — SE Suite 2.0

 Integration via database 255

NMFIELD60 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD61 TEXT 255
NMFIELD60 field.

NMFIELD62 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD63 TEXT 255
NMFIELD62 field.

NMFIELD64 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD65 TEXT 255
NMFIELD64 field.

NMFIELD66 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD67 TEXT 255
NMFIELD66 field.

NMFIELD68 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD69 TEXT 255
NMFIELD68 field.

NMFIELD70 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD71 TEXT 255
NMFIELD70 field.

NMFIELD72 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD73 TEXT 255
NMFIELD72 field.

NMFIELD74 TEXT 255 Attribute ID #.

Value of the attribute specified in the

NMFIELD75 TEXT 255
NMFIELD74 field.

DSFIELD01 TEXT 4000 Timesheet comments.

Example of timesheet insertion/editing:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD08, NMFIELD09,
DSFIELD01) VALUES (1, 1, 41, 1, '000001', '000001', '1', '2010-01-01', '08:00',
'18:00', '1', '000001', 'Notes');

Integration guide — SE Suite 2.0

 Integration via database 256

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD07, NMFIELD08, NMFIELD09, DSFIELD01,
NMFIELD22, NMFIELD23, NMFIELD24, NMFIELD25) VALUES (1, 1, 41, 1, '000001', '000001',
'1', '2010-01-01', '08:00', '1', '000001', 'Notes', 'Attribute 1', 'Attribute value
1', 'Attribute 2', 'Attribute value 2');

Integration guide — SE Suite 2.0

 Integration via database 257

4.6.16 - Survey

This section contains the following topics:

§ SRVGUESTUSER - Guest respondent

Integration guide — SE Suite 2.0

 Integration via database 258

4.6.16.1 - SRVGUESTUSER - Guest respondent

This import template makes it possible to insert:

§ Guest respondents who will be added to the survey. The survey must be previously created.

To insert each of these respondents, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies a respondent to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:
1 – New;
FGIMPORT X NUMERIC 2 2 – In progress;
3 – Finished;
4 – Error;

System code where the integration will be performed

C DISOSYSTEM X NUMERIC 10 to:
214 – C ode of component SE Survey

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
1 – Insert respondent

NMFIELD01 X TEXT 255 Survey ID #

NMFIELD02 X TEXT 255 Respondent name

NMFIELD03 X TEXT 255 Respondent email

Example of Respondent insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 214, 2, 'ID', 'Name', '[email protected]');

Integration guide — SE Suite 2.0

 Integration via database 259

4.6.17 - Waste

This section contains the following topics:

§ WMSHIPATTRIBASSOC - Import of association of attributes with the transport

§ WMWASTEATTRIB - Attribute import

§ WMWASTEATTRIBASSOC - Import of association of attributes with the waste

§ WMWASTEATTRIBVALUE - Import of attribute values

Integration guide — SE Suite 2.0

 Integration via database 260

4.6.17.1 - WMSHIPATTRIBASSOC - Import of association of

attributes with the transport

This import template makes it possible to insert:

§ Data of an association of attributes with the transport.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

17 - C ode of component SE Waste.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
94 - Inserts a new attribute association.

NMFIELD01 X TEXT 255 Waste ID #.

NMFIELD02 X TEXT 255 Attribute ID #.

Attribute value.

Standards to enter date type data:

X TEXT 255
NMFIELD03 § dd/mm/yyyy;

§ yyyy-mm-dd.

Revision ID #.

Required information if the component

NMFIELD04 TEXT 255
needs the revision code in the specific
table of the attribute.

C ode of the association type:

NMFIELD05 X NUMERIC 2 2 - Association of attributes with the
transport.

Integration guide — SE Suite 2.0

 Integration via database 261

Example of the function to insert attribute associations:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 17, 1, 94, 'TRANS000001',
'INVOICE', '12055565', NULL, 2);

Integration guide — SE Suite 2.0

 Integration via database 262

4.6.17.2 - WMWASTEATTRIB - Attribute import

This import template makes it possible to insert:

§ Data of an attribute.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

17 - C ode of component SE Waste.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
96 - Inserts a new attribute.

NMFIELD01 X TEXT 255 Attribute ID #.

NMFIELD02 X TEXT 255 Attribute name.

NMFIELD03 X TEXT 255 User ID #.

Attribute type:

1 - List of values;
NMFIELD04 X TEXT 255
2 - Non-discrete;

3 - External.

Integration guide — SE Suite 2.0

 Integration via database 263

Attribute data type.

List of values:

1 - Text;

2 - Numeric;

3 - Date;

5 - C urrency.

Non-discrete:
NMFIELD05 TEXT 255
1 - Text;

2 - Numeric;

3 - Date;

4 - Memo;

5 - C urrency.

External:

1 - Text.

Selection mode.

The 'List of Values' and 'External' attribute

types must inform the 'Selection Mode'.
Accepted values:

1 - Zoom;
NMFIELD06 TEXT 255
2 - C ombo.

'List of Values' attribute type can inform

whether the attribute will be multivalued.
Accepted values:

1 - Multivalued.

NMFIELD07 TEXT 255 Multivalued.

Example of the function to insert attributes:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07) VALUES (01, 17, 1,
96, 'LDATA', 'Data List', 'Peter',’1’,’3’,’2’);

Integration guide — SE Suite 2.0

 Integration via database 264

4.6.17.3 - WMWASTEATTRIBASSOC - Import of association

of attributes with the waste

This import template makes it possible to insert:

§ Data of an association of attributes with the waste.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

17 - C ode of component SE Waste.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
94 - Inserts a new attribute association.

NMFIELD01 X TEXT 255 Waste ID #.

NMFIELD02 X TEXT 255 Attribute ID #.

Attribute value.

Standards to enter date type data:

X TEXT 255
NMFIELD03 · dd/mm/yyyy;

· yyyy-mm-dd.

Revision ID #.

Required information if the component

NMFIELD04 TEXT 255
needs the revision code in the specific
table of the attribute.

C ode of the association type:

NMFIELD05 X NUMERIC 2
1 - Association of attributes with the waste.

Integration guide — SE Suite 2.0

 Integration via database 265

Example of the function to insert attribute associations:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05) VALUES (1, 17, 1, 94, 'WAS000001',
'WEIGHT', '120 Kg', NULL, 1);

Integration guide — SE Suite 2.0

 Integration via database 266

4.6.17.4 - WMWASTEATTRIBVALUE - Import of attribute

values

This import template makes it possible to insert:

§ Data of an attribute value.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

17 - C ode of component SE Waste.

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
95 - Inserts a new attribute value.

NMFIELD01 X TEXT 255 Attribute ID #.

Attribute value.

Required information if the attribute type

NMFIELD02 X TEXT 255 is List of values. Non-discrete type
attributes will not be accepted for the
import of values.

Use as default.

1 - The value of the attribute will be the

NMFIELD03 X TEXT 255 default for the attribute.

2 - The value of the attribute will not be

the default for the attribute.

NMFIELD04 X TEXT 255 User ID #.

Server (name or IP address of the

NMFIELD05 TEXT 255
external attribute database).

NMFIELD06 TEXT 255 Alias/Database path (external attribute).

Integration guide — SE Suite 2.0

 Integration via database 267

NMFIELD07 TEXT 255 Database user (external attribute).

NMFIELD08 TEXT 255 Password (external attribute).

DB type.

1 - ITERBASE;

2 - MSSQL;

3 - MSSQL (ODBC );

4 - ORAC LE < 8.05;

5 - ORAC LE 8/9(SERVIC E NAME);

NMFIELD09 TEXT 255 6 - ORAC LE8/9(SID);

7 - ORAC LE (ODBC );

8 - DB2 (ODBC );

9 - INFORMIX;

10 - ORAC LE 8/9 (TNS NAME);

11 - MySQL;

12 - POSTGRESQL.

SQL (Select that will search for the

NMFIELD10 TEXT 255
external attribute field).

Field.

NMFIELD11 TEXT 255 Standards to enter date type data:

· yyyy-mm-dd.

Example of the function to insert attribute values:

INSERT INTO ADINTERFACE (CDINTERFACE, CDISOSYSTEM, FGIMPORT, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11) VALUES (01, 17, 1, 95, 'LDATA', 'Data List', '1',
'DEV145', 'Peter', 'BDORACLE',’th01’,’1’,’ORACLE’,’’ ,’’);

Integration guide — SE Suite 2.0

 Integration via database 268

4.6.18 - Risks

This section contains the following topics:

§ RICONTROLATTRIBUTE - Control attribute value

§ RIRISKATTRIBUTE – Risk attribute value

§ RISBESTPRACTICE – Best practice

§ RISBESTPRACTICETYPE – Best practice type

§ RISCONSEQUENCE – Consequence

§ RISCONSEQUENCETYPE – Consequence type

§ RISCONTROL – Control

§ RISCONTROLTYPE – Control type

§ RISITEM – Element

§ RISITEMTYPE – Element type

§ RISOBJECTIVE – Objective

§ RISOBJECTIVETYPE – Objective type

§ RISRISK – Risk

§ RISRISKTYPE – Risk type

§ RISSOURCE – Risk source

§ RISSOURCETYPE – Risk source type

§ RISTREATMENT – Treatment

§ RISTREATMENTTYPE – Treatment type

Integration guide — SE Suite 2.0

 Integration via database 269

4.6.18.1 - RICONTROLATTRIBUTE - Control attribute value

This import template makes it possible to insert:

§ Values to attributes of a control. To insert more than one value into a multivalued attribute, repeat all data

and only change the value of the attribute (NMFIELD03).

To insert each of these respondents, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be performed

C DISOSYSTEM X NUMERIC 10 to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
18 – Add the value to the control attribute.

NMFIELD01 X TEXT 255 C ontrol ID #

NMFIELD02 X TEXT 255 Attribute ID #.

Attribute value

Standards to enter date type data:

§ dd/mm/yyyy;
NMFIELD03 TEXT 255
§ dd/mm/yyyy;

§ Standards to enter the hour type data:

§ hhhh:mm.

DSFIELD01 TEXT 4000 Attribute description.

X 1 - The NMFIELD03 column is mandatory for all attributes, EXC EPT the ones of the Memo type, where the DSFIELD01
column should be filled in.

Integration guide — SE Suite 2.0

 Integration via database 270

Example of insertion of risk attribute values:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (1, 1, 215, 18, 'Control01',
'ControlAttribute', '19/06/2017', '');

Integration guide — SE Suite 2.0

 Integration via database 271

4.6.18.2 - RIRISKATTRIBUTE – Risk attribute value

This import template makes it possible to insert:

§ Values to attributes of a risk. To insert more than one value into a multivalued attribute, add another row

with the same data and only change the value of the attribute (NMFIELD03).

To insert each of these respondents, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies a respondent to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:
1 – New;
FGIMPORT X NUMERIC 2 2 – In progress;
3 – Finished;
4 – Error;

System code where the integration will be performed

C DISOSYSTEM X NUMERIC 10 to:
215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
17 – Add the value to the risk attribute.

NMFIELD01 X TEXT 255 Risk ID #

NMFIELD02 X TEXT 255 Attribute ID #

Attribute value

Standards to enter date type data:

§ dd/mm/yyyy;
NMFIELD03 TEXT 255
§ dd/mm/yyyy;

§ Standards to enter the hour type data:

§ hhhh:mm.

DSFIELD01 TEXT 4000 Attribute description.

X 1 - The NMFIELD03 column is mandatory for all attributes, EXC EPT the ones of the Memo type, where the DSFIELD01
column should be filled in.

Integration guide — SE Suite 2.0

 Integration via database 272

Example of insertion of risk attribute values:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (1, 1, 215, 17, 'Risk01', 'RiskAttribute',
'16/09/2017', '');

Integration guide — SE Suite 2.0

 Integration via database 273

4.6.18.3 - RISBESTPRACTICE – Best practice

This import template makes it possible to insert:

§ Best practices.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
13 – Insert Best practice

NMFIELD01 X TEXT 50 Best practice ID #

NMFIELD02 X TEXT 255 Best practice name

NMFIELD03 X TEXT 50 Best practice type ID #

DSFIELD01 TEXT 4000 Best practice description

Example of Best practice insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (1, 1, 215, 13, 'ID', 'Name', 'Type',
'Description');

Integration guide — SE Suite 2.0

 Integration via database 274

4.6.18.4 - RISBESTPRACTICETYPE – Best practice type

This import template makes it possible to insert:

§ Best practice types.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
5 – Insert Best practice type

NMFIELD01 X TEXT 50 Best practice type ID #

NMFIELD02 X TEXT 255 Best practice type name

NMFIELD03 TEXT 50 Upper level type ID #

Example of Best practice type insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 215, 5, 'ID', 'Name', 'UpperLevelType');

Integration guide — SE Suite 2.0

 Integration via database 275

4.6.18.5 - RISCONSEQUENCE – Consequence

This import template makes it possible to insert:

§ Consequences.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
9 – Insert consequence

NMFIELD01 X TEXT 50 C onsequence ID #

NMFIELD02 X TEXT 255 C onsequence name

NMFIELD03 X TEXT 50 C onsequence type ID #

DSFIELD01 TEXT 4000 C onsequence description

Example of Consequence insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (1, 1, 215, 9, 'ID', 'Name', 'Type',
'Description');

Integration guide — SE Suite 2.0

 Integration via database 276

4.6.18.6 - RISCONSEQUENCETYPE – Consequence type

This import template makes it possible to insert:

§ Consequence types.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
3 – Insert C onsequence type

NMFIELD01 X TEXT 50 C onsequence type ID #

NMFIELD02 X TEXT 255 C onsequence type name

NMFIELD03 TEXT 50 Upper level type ID #

Example of Consequence type insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 215, 3, 'ID', 'Name', 'UpperLevelType');

Integration guide — SE Suite 2.0

 Integration via database 277

4.6.18.7 - RISCONTROL – Control

This import template makes it possible to insert:

§ Controls.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
10 – Insert C ontrol

NMFIELD01 X TEXT 50 C ontrol ID #

NMFIELD02 X TEXT 255 C ontrol name

NMFIELD03 X TEXT 50 C ontrol type ID #

NMFIELD04 TEXT 50 Responsibility user ID #

NMFIELD05 TEXT 50 Responsible team ID #.

Implementation:

1 – Not implemented;
NMFIELD06 NUMERIC 2
2 – Partly implemented;

3 – C ompletely implemented;

NMFIELD07 TEXT 255 Implementation date

Relevant:

NMFIELD08 NUMERIC 2 1 – Yes;

2 – No;

Integration guide — SE Suite 2.0

 Integration via database 278

Automation type:

1 – Automatic;
NMFIELD09 NUMERIC 2
2 – Semiautomatic;

2 – Manual;

C ontrol characteristic:

NMFIELD10 NUMERIC 2 1 – Detectable;

2 – Preventive;

Automation:

1 – Workflow;
NMFIELD11 NUMERIC 2
2 - Survey;

3 – Test;

Process ID #
NMFIELD12 TEXT 50 (It will only be considered if the control is
automated by Workflow)

Survey form ID #
NMFIELD13 TEXT 50 (It will only be considered if the control is
automated by Survey)

Test form ID #
NMFIELD14 TEXT 50 (It will only be considered if the control is
automated by Test)

Procedure ID # (Document)
NMFIELD15 TEXT 50 (It will only be considered if the control is
automated)

NMFIELD16 NUMERIC 2 C ontrol icon id #

DSFIELD01 TEXT 4000 C ontrol description

Example of Control insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, NMFIELD12, NMFIELD13, NMFIELD14, NMFIELD15,
NMFIELD16, DSFIELD01) VALUES (1, 1, 215, 10, 'ID', 'Name', 'Type', 'Responsible',
'ResponsibleTeam', 1, '31/12/2014', 1, 1, 1, 1, 'Process', 'Procedure', 1,
'Description');

Integration guide — SE Suite 2.0

 Integration via database 279

4.6.18.8 - RISCONTROLTYPE – Control type

This import template makes it possible to insert:

§ Control types.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
1 – Insert C ontrol type

NMFIELD01 X TEXT 50 C ontrol type ID #

NMFIELD02 X TEXT 255 C ontrol type name

NMFIELD03 TEXT 50 Upper level type ID #

Example of Control type insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 215, 1, 'ID', 'Name', 'UpperLevelType');

Integration guide — SE Suite 2.0

 Integration via database 280

4.6.18.9 - RISITEM – Element

This import template makes it possible to insert:

§ Elements.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
11 – Insert Element

NMFIELD01 X TEXT 50 Element ID #

NMFIELD02 X TEXT 255 Element name

NMFIELD03 X TEXT 50 Element type ID #

DSFIELD01 TEXT 4000 Element description

Example of element insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (1, 1, 215, 11, 'ID', 'Name', 'Type',
'Description');

Integration guide — SE Suite 2.0

 Integration via database 281

4.6.18.10 - RISITEMTYPE – Element type

This import template makes it possible to insert:

§ Element types.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
8 – Insert Element type

NMFIELD01 X TEXT 50 Element type ID #

NMFIELD02 X TEXT 255 Element type name

NMFIELD03 TEXT 50 Upper level type ID #

Example of Element type insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 215, 8, 'ID', 'Name', 'UpperLevelType');

Integration guide — SE Suite 2.0

 Integration via database 282

4.6.18.11 - RISOBJECTIVE – Objective

This import template makes it possible to insert:

§ Objectives.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
14 – Insert Objective

NMFIELD01 X TEXT 50 Objective ID #

NMFIELD02 X TEXT 255 Objective name

NMFIELD03 X TEXT 50 Objective type ID #

DSFIELD01 TEXT 4000 Objective description

Example of objective insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (1, 1, 215, 14, 'ID', 'Name', 'Type',
'Description');

Integration guide — SE Suite 2.0

 Integration via database 283

4.6.18.12 - RISOBJECTIVETYPE – Objective type

This import template makes it possible to insert:

§ Objective type.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
6 – Insert Objective type

NMFIELD01 X TEXT 50 Objective type ID #

NMFIELD02 X TEXT 255 Object type name

NMFIELD03 TEXT 50 Upper level type ID #

Example of Objective type insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 215, 6, 'ID', 'Name', 'UpperLevelType');

Integration guide — SE Suite 2.0

 Integration via database 284

4.6.18.13 - RISRISK – Risk

This import template makes it possible to insert:

§ Risks.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
15 – Insert Risk

NMFIELD01 X TEXT 50 Risk ID #

NMFIELD02 X TEXT 255 Risk name

NMFIELD03 X TEXT 255 Risk type ID #

NMFIELD04 TEXT 50 Responsibility user ID #

NMFIELD05 TEXT 50 Responsible team ID #.

Risk classification:

NMFIELD06 NUMERIC 2 1 – Loss;

2 – Opportunity;

NMFIELD07 TEXT 50 Incident type ID #

NMFIELD08 TEXT 50 Problem type ID #

NMFIELD09 NUMERIC 2 Risk icon ID #

DSFIELD01 TEXT 4000 Risk description

Integration guide — SE Suite 2.0

 Integration via database 285

Example of risk insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION,

NMFIELD01,NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07,
NMFIELD08, NMFIELD09, DSFIELD01) VALUES (1, 1, 215, 15, 'ID', 'Name', 'Type',
'Responsible', 'ResponsibleTeam', 1, 'IncidentType', 'ProblemType', 0,
'Description')

Integration guide — SE Suite 2.0

 Integration via database 286

4.6.18.14 - RISRISKTYPE – Risk type

This import template makes it possible to insert:

§ Risk types.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
7 – Insert Risk type

NMFIELD01 X TEXT 50 Risk type ID #

NMFIELD02 X TEXT 255 Risk type name

NMFIELD03 TEXT 50 Upper level type ID #

Example of Risk type insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 215, 7, 'ID', 'Name', 'UpperLevelType');

Integration guide — SE Suite 2.0

 Integration via database 287

4.6.18.15 - RISSOURCE – Risk source

This import template makes it possible to insert:

§ Risk sources.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
12 – Insert Risk source

NMFIELD01 X TEXT 50 Risk source ID #

NMFIELD02 X TEXT 255 Risk source name

NMFIELD03 X TEXT 50 Risk source type ID #

DSFIELD01 TEXT 4000 Risk source description

Example of Risk source insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (1, 1, 215, 12, 'ID', 'Name', 'Type',
'Description');

Integration guide — SE Suite 2.0

 Integration via database 288

4.6.18.16 - RISSOURCETYPE – Risk source type

This import template makes it possible to insert:

§ Risk source types.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
4 – Insert Risk source type

NMFIELD01 X TEXT 50 Risk source type ID #

NMFIELD02 X TEXT 255 Risk source type name

NMFIELD03 TEXT 50 Upper level type ID #

Example of Risk source type insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 215, 4, 'ID', 'Name', 'UpperLevelType');

Integration guide — SE Suite 2.0

 Integration via database 289

4.6.18.17 - RISTREATMENT – Treatment

This import template makes it possible to insert:

§ Treatments.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
16 – Insert Treatment

NMFIELD01 X TEXT 50 Treatment ID #

NMFIELD02 X TEXT 255 Treatment name

NMFIELD03 X TEXT 50 Treatment type ID #

DSFIELD01 TEXT 4000 Treatment description

Example of Treatment insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, DSFIELD01) VALUES (1, 1, 215, 16, 'ID', 'Name', 'Type',
'Description');

Integration guide — SE Suite 2.0

 Integration via database 290

4.6.18.18 - RISTREATMENTTYPE – Treatment type

This import template makes it possible to insert:

§ Treatment types.

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 - New;

FGIMPORT X NUMERIC 2 2 - In progress;

3 - Finished;

4 - Error.

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

215 – C ode of component SE Risk

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
2 – Insert Treatment type

NMFIELD01 X TEXT 50 Treatment type ID #

NMFIELD02 X TEXT 255 Treatment type name

NMFIELD03 TEXT 50 Upper level type ID #

Example of Treatment type insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 215, 2, 'ID', 'Name', 'UpperLevelType');

Integration guide — SE Suite 2.0

 Integration via database 291

4.6.19 - Test

This section contains the following topics:

§ TSTGUESTUSER - Guest respondent

Integration guide — SE Suite 2.0

 Integration via database 292

4.6.19.1 - TSTGUESTUSER - Guest respondent

This import template makes it possible to insert:

§ Guest respondents who will be added to the test. The test must be created beforehand.

To insert each of these respondents, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies a respondent to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be performed

C DISOSYSTEM X NUMERIC 10 to:

218 – C ode of component SE Test

C ode of the operation to be performed:

FGOPTION X NUMERIC 2
2 – Insert respondent

NMFIELD01 X TEXT 255 Test ID #

NMFIELD02 X TEXT 255 Respondent name

NMFIELD03 X TEXT 255 Respondent email

Example of Insertion:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03) VALUES (1, 1, 218, 2, 'ID', 'Name', '[email protected]');

Integration guide — SE Suite 2.0

 Integration via database 293

4.6.20 - Training

This section contains the following topics:

§ TRASSOC - Participant evaluation and/or association

§ TRREG - Training record creation

Integration guide — SE Suite 2.0

 Integration via database 294

4.6.20.1 - TRASSOC - Participant evaluation and/or

association

This import template enables to insert/edit:

§ Evaluation of training participants

§ Association of participants with trainings

To insert each of these items, it is necessary to follow the standard documented below.

Insert/edit

Column Required Type Precision Description

Sequential code - Identifies an item to be

C DINTERFAC E X NUMERIC 10
imported into SE Suite.

Import status:
1 – New;
FGIMPORT X NUMERIC 2 2 – In progress;
3 – Finished;
4 – Error;

System code where the integration will be

C DISOSYSTEM X NUMERIC 10 performed to:

129

4 – Evaluates participant; if not associated,

FGOPTION X NUMERIC 2 associates it with the training.

5 – Only evaluates the participant.

NMFIELD01 X TEXT 255 Training ID #.

NMFIELD02 X TEXT 255 Participant ID #.

NMFIELD03 TEXT 255 Appraiser ID # of effectiveness evaluation.

NMFIELD04 TEXT 255 Pre-training evaluation score.

NMFIELD05 TEXT 255 Training evaluation score.

NMFIELD06 TEXT 255 Reaction evaluation score.

NMFIELD07 TEXT 255 Post-training evaluation score.

NMFIELD08 TEXT 255 Training evaluation frequency.

Training evaluation result (1- Passed / 2 -

NMFIELD09 TEXT 255
Failed).

Post-training evaluation result (1 - Passed / 2 -

NMFIELD10 TEXT 255
Failed).

Integration guide — SE Suite 2.0

 Integration via database 295

Effectiveness evaluation result (1- Passed / 2 -

NMFIELD11 TEXT 255
Failed).

DSFIELD01 TEXT 4000 Pre-training evaluation description.

DSFIELD02 TEXT 4000 Training evaluation description.

DSFIELD03 TEXT 4000 Reaction evaluation description.

DSFIELD04 TEXT 4000 Post-training evaluation description.

DSFIELD05 TEXT 4000 Effectiveness evaluation description.

Example:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11, DSFIELD01, DSFIELD02, DSFIELD03, DSFIELD04,
DSFIELD05) VALUES (1,1,129,5, 'Training ID #', 'Participant ID #','Effectiveness
evaluation appraiser id #', 7, 8, 9, 10, 75, 1, 1, 2, 'Pre-training', 'Reaction',
'Training', 'Post-training', 'Effectiveness');

Integration guide — SE Suite 2.0

 Integration via database 296

4.6.20.2 - TRREG - Training record creation

This import template enables to insert/edit:

§ Trainings

To insert each of these items, it is necessary to follow the standard documented below.

Insert

Column Required Type Precision Description

Sequential code - Identifies an item to be imported

C DINTERFAC E X NUMERIC 10
into SE Suite.

Import status:

1 – New;

FGIMPORT X NUMERIC 2 2 – In progress;

3 – Finished;

4 – Error;

System code where the integration will be performed

C DISOSYSTEM X NUMERIC 10 to:

129 – Training component code.

C ode of the operation to be performed:

1 - C reates a new training

FGOPTION X NUMERIC 2
2 - Edits training

3 - Edits training; if nonexistent, adds a new one

NMFIELD01 X TEXT 255 Training type (1 - C ollective; 2 - Individual).

Participant ID # (Required in case of the training

NMFIELD02 TEXT 255
being individual).

Training ID # (When editing is the only required field

NMFIELD03 X TEXT 255
combining with the first 4).

NMFIELD04 X TEXT 255 Training name

NMFIELD05 X TEXT 255 C ourse ID #

NMFIELD06 X TEXT 255 C onfiguration ID #

NMFIELD07 TEXT 255 Training method id #.

Planning control team id # (Required in case of the

NMFIELD08 TEXT 255
training planning).

Execution control team id # (Required in case of it

NMFIELD09 TEXT 255
being execution or training planning).

Integration guide — SE Suite 2.0

 Integration via database 297

Training execution location:

NMFIELD10 X TEXT 255
(1 – Internal; 2 – External).

NMFIELD11 TEXT 255 Instructor.

Allow the instructor to control the training execution

NMFIELD12 TEXT 255
(1 – Yes; 2 – No).

NMFIELD13 TEXT 255 Educational entity id #.

NMFIELD14 TEXT 255 Support staff.

Planned start date (Required in case of the creation

NMFIELD15 TEXT 255
of training planning).

Planned end date (Required in case of the creation of

NMFIELD16 TEXT 255
training planning).

Planned workload (Required in case of the creation of

NMFIELD17 TEXT 255
training planning).

Actual start date (Required in case of the creation of

NMFIELD18 TEXT 255
the training execution).

NMFIELD19 TEXT 255 Actual end date.

Actual workload (Required in case of the creation of

NMFIELD20 TEXT 255
training execution).

Make content available to the training participants (1

NMFIELD21 TEXT 255
– Yes; 2 – No).

Maintain access for participants after content

NMFIELD22 TEXT 255
execution. (1 – Yes; 2 – No).

Require participants to access the training content

NMFIELD23 TEXT 255
before sending it to the next step (1 – Yes; 2 – No).

Automate the training flow when finishing the content

NMFIELD24 TEXT 255
execution (1 – Yes; 2 – No).

When the training status is in planning: Deadline

frequency amount for content access;
NMFIELD25 TEXT 255
When the training status is in execution or above it:
Deadline (date) for content access.

When the Training status is in planning: Deadline

NMFIELD26 TEXT 255 frequency for content access (1 – Day; 2 – Week; 3
– Month; 4 – Year).

Block content access after the deadline expires (1 –

NMFIELD27 TEXT 255
Yes; 2 – No).

NMFIELD28 TEXT 255 Extra signature (1 – Yes; 2 – No).

Integration guide — SE Suite 2.0

 Integration via database 298

NMFIELD29 TEXT 255 Name of additional signature.

NMFIELD30 TEXT 255 Pre-training evaluation [1 - Yes; 2 - No].

Pre-training evaluation type (1 - Score; 2 –

NMFIELD31 TEXT 255
Descriptive).

NMFIELD32 TEXT 255 Pre-training evaluation test template ID #

Responsible team for completing the pre-training

NMFIELD33 TEXT 255
evaluation test id #.

When the training status is in the planning or

execution, and the pre-training assessment is not
being performed: Deadline frequency amount for
answering the test of pre-training evaluation;
NMFIELD34 TEXT 255
When the training status is in evaluation or in
execution and with the pre-training evaluation being
executed: Deadline to answer the pre-training
assessment test.

When the training status is in planning or execution

and the pre-training evaluation is not being
NMFIELD35 TEXT 255 performed: Deadline frequency for answering the
test of pre-training evaluation (1 – Day; 2 – Week; 3
– Month; 4 – Year).

NMFIELD36 TEXT 255 Pre-training evaluation required (1 – Yes; 2 – No).

NMFIELD37 TEXT 255 Training evaluation (1 – Yes; 2 – No).

Training evaluation type (1 – Single; 2 – Score and

NMFIELD38 TEXT 255
attendance; 3 – Simple approval).

NMFIELD39 TEXT 255 Minimum score of training evaluation.

NMFIELD40 TEXT 255 Minimum training evaluation frequency.

NMFIELD41 TEXT 255 Training evaluation test template ID #

Responsible team for completing the training

NMFIELD42 TEXT 255
assessment test id #.

When the training status is in planning or execution,

and the training evaluation is not being performed:
Deadline frequency amount for answering the test of
NMFIELD43 TEXT 255 training evaluation;

When the training status is in evaluation or execution

and with the training evaluation being executed:
Deadline to answer the training evaluation test.

When the training status is in planning or execution

NMFIELD44 TEXT 255
and the training evaluation is not being executed:

Integration guide — SE Suite 2.0

 Integration via database 299

Deadline frequency for answering the test of training

evaluation (1 – Day; 2 – Week; 3 – Month; 4 – Year).

NMFIELD45 TEXT 255 Training evaluation required (1 – Yes; 2 – No).

Use of training evaluation as training result (1 – Yes;

NMFIELD46 TEXT 255
2 – No).

NMFIELD47 TEXT 255 Reaction evaluation (1 – Yes; 2 – No).

Reaction evaluation type (1 – Score; 2 –

NMFIELD48 TEXT 255
Descriptive).

NMFIELD49 TEXT 255 Survey template of reaction evaluation id #

Responsible team for completing the reaction

NMFIELD50 TEXT 255
evaluation survey id #

When the training status is in planning or execution,

and the reaction evaluation is not being performed:
Deadline frequency amount for answering the
NMFIELD51 TEXT 255 reaction evaluation survey;

When the training status is in evaluation or execution,

and with the training evaluation being performed:
Deadline to answer the reaction evaluation survey.

When the training status is in planning or execution,

and the reaction evaluation is not being performed:
NMFIELD52 TEXT 255 Deadline frequency for answering the survey of
reaction evaluation (1 – Day; 2 – Week; 3 – Month; 4
– Year).

NMFIELD53 TEXT 255 Reaction evaluation required (1 – Yes; 2 – No).

NMFIELD54 TEXT 255 Anonymous survey (1 – Yes; 2 – No).

NMFIELD55 TEXT 255 Post-training evaluation (1 – Yes; 2 – No).

Post-training evaluation type (1 – Score; 2 – Simple

NMFIELD56 TEXT 255
approval).

NMFIELD57 TEXT 255 Minimum score of post-training evaluation.

NMFIELD58 TEXT 255 Post-training evaluation test template ID #

Responsible team for completing the post-training

NMFIELD59 TEXT 255
evaluation test id #.

When the training status is in planning or execution,

and the post-training evaluation is not being
NMFIELD60 TEXT 255
performed: Deadline frequency amount for
answering the test of post training evaluation;

Integration guide — SE Suite 2.0

 Integration via database 300

When the training status is in evaluation or execution,

and with the post-training evaluation being executed:
Deadline to answer the post training evaluation test.

When the training status is in planning or in

execution, and the post-training evaluation is not
NMFIELD61 TEXT 255 being executed: Deadline frequency for answering
the test of post-training evaluation (1 – Day; 2 –
Week; 3 – Month; 4 – Year).

When the training status is in planning or in

execution, and the post-training evaluation is not
being executed: Delay frequency amount of post-
NMFIELD62 TEXT 255 training evaluation;

When the training status is in evaluation or execution,

and the post-training evaluation is being executed:
Date of grace period of the post-training evaluation.

When the training status is in evaluation or execution,

and the post-training evaluation is being executed:
NMFIELD63 TEXT 255
Date of grace period of the post-training evaluation
(1 – Day; 2 – Week; 3 – Month; 4 – Year).

NMFIELD64 TEXT 255 Post-training evaluation required (1 – Yes; 2 – No).

Use of post-training evaluation as training result (1 –

NMFIELD65 TEXT 255
Yes; 2 – No).

Evaluation of participant effectiveness (1 – Yes; 2 –

NMFIELD66 TEXT 255
No).

Participant effectiveness evaluation type (1 – Score;

NMFIELD67 TEXT 255
2 – Simple approval).

Minimum score of participant effectiveness

NMFIELD68 TEXT 255
evaluation.

Survey template of participant effectiveness

NMFIELD69 TEXT 255
evaluation id #.

Responsible team for completing the participant

NMFIELD70 TEXT 255
effectiveness evaluation survey id #.

When the training status is in planning or in

execution, and the evaluation of participant
effectiveness is not being executed: Deadline
NMFIELD71 TEXT 255 frequency amount for answering the survey of
evaluation of participant effectiveness;

When the training status is in evaluation or execution,

and with the evaluation of participant effectiveness

Integration guide — SE Suite 2.0

 Integration via database 301

being executed: Deadline to answer the survey of

evaluation of participant effectiveness.

When the training situation is in planning or in

execution, and the evaluation of participant
effectiveness is not being executed: Deadline
NMFIELD72 TEXT 255
frequency for answering the survey of evaluation of
participant effectiveness (1 – Day; 2 – Week; 3 –
Month; 4 – Year).

When the training situation is in planning or in

execution, and the evaluation of participant
effectiveness is not being executed: Delay frequency
amount of participant effectiveness evaluation;
NMFIELD73 TEXT 255
When the training situation is in planning or in
execution, and the evaluation of participant
effectiveness is being executed: Date of grace period
of the evaluation of participant effectiveness.

When the training situation is in planning or in

execution, and the evaluation of participant
NMFIELD74 TEXT 255 effectiveness is not being executed: Delay frequency
of participant effectiveness evaluation (1 – Day; 2 –
Week; 3 – Month; 4 – Year).

Participant effectiveness evaluation required (1 –

NMFIELD75 TEXT 255
Yes; 2 – No).

Use of participant effectiveness evaluation as training

NMFIELD76 TEXT 255
result (1 – Yes; 2 – No).

NMFIELD77 TEXT 255 Use default calendar (1 – Yes; 2 – No).

NMFIELD78 TEXT 255 C alendar ID #.

NMFIELD79 TEXT 255 Training frequency standard (1 – Daily; 2 – Weekly).

Training occurrence (1 – Every day; 2 – With day

NMFIELD80 TEXT 255
intervals).

Number of days in the interval between a training

NMFIELD81 TEXT 255
day and another.

Week days of training occurrence (The days are

determined from Monday to Sunday, defining 1 for
NMFIELD82 TEXT 255 yes and 2 for no, separated by a semicolon “;”.
Example: 1;1;1;1;1;2;2. In this case the training
would only have occurred on Saturday and Sunday).

NMFIELD83 TEXT 255 Allow training in non-working days (1 – Yes; 2 – No).

NMFIELD84 TEXT 255 Use attendance list (1 – Yes; 2 – No).

Integration guide — SE Suite 2.0

 Integration via database 302

Training confirmation type (1 – Participants; 2 –

NMFIELD85 TEXT 255
Automatic; 3 – Responsible).

NMFIELD86 TEXT 255 Deadline (days) for training confirmation.

NMFIELD87 TEXT 255 Training effectiveness verification (1 – Yes; 2 – No).

NMFIELD88 TEXT 255 Responsible for effectiveness verification id #.

When the training status is in planning or in execution

without an end date set: Deadline frequency amount
for the verification date of training effectiveness;
NMFIELD89 TEXT 255
When the training status is in planning or in execution
without an end date set: Deadline for the training
effectiveness verification.

When the training status is in planning or in execution

NMFIELD90 TEXT 255 without an end date set: Deadline frequency for the
training effectiveness verification.

NMFIELD91 TEXT 255 Evaluation date of training effectiveness verification.

NMFIELD92 TEXT 255 Effective training (1 – Yes; 2 – No).

NMFIELD93 TEXT 255 Invalidate training (1 – Yes; 2 – No).

NMFIELD94 TEXT 255 Enrollment type (1 – Restricted; 2 – Public).

NMFIELD95 TEXT 255 Number of participants allowed for enrollment.

NMFIELD96 TEXT 255 Enrollment deadline.

Process selection type (1 – First-come basis; 2 –

NMFIELD97 TEXT 255
C hosen by the responsible user).

NMFIELD98 TEXT 255 Training validity (1 – Yes; 2 – No).

NMFIELD99 TEXT 255 Deadline frequency amount of training validity

Deadline frequency for training validity (1 – Day; 2 –

NMFIELD100 TEXT 255
Week; 3 – Month; 4 – Year).

DSFIELD01 TEXT 4000 Objective.

DSFIELD02 TEXT 4000 C omments.

DSFIELD03 TEXT 4000 C omments on pre-training evaluation.

DSFIELD04 TEXT 4000 C omments on training evaluation.

DSFIELD05 TEXT 4000 C omments on reaction evaluation.

DSFIELD06 TEXT 4000 C omments on post-training evaluation.

DSFIELD07 TEXT 4000 C omments on participant effectiveness evaluation.

Integration guide — SE Suite 2.0

 Integration via database 303

DSFIELD08 TEXT 4000 Evaluation method of training effectiveness.

Objective evidence of training effectiveness

DSFIELD09 TEXT 4000
verification.

Example:

INSERT INTO ADINTERFACE (CDINTERFACE, FGIMPORT, CDISOSYSTEM, FGOPTION, NMFIELD01,

NMFIELD02, NMFIELD03, NMFIELD04, NMFIELD05, NMFIELD06, NMFIELD07, NMFIELD08,
NMFIELD09, NMFIELD10, NMFIELD11,NMFIELD12, NMFIELD13, NMFIELD14, DSFIELD01,
DSFIELD02, NMFIELD15, NMFIELD16, NMFIELD17, NMFIELD18, NMFIELD19, NMFIELD20,
NMFIELD21, NMFIELD22, NMFIELD23, NMFIELD24, NMFIELD25, NMFIELD26, NMFIELD27,
NMFIELD28, NMFIELD29, NMFIELD30, NMFIELD31, NMFIELD32, NMFIELD33, NMFIELD34,
NMFIELD35, NMFIELD36, NMFIELD37, DSFIELD03, NMFIELD38, NMFIELD39, NMFIELD40,
NMFIELD41, NMFIELD42, NMFIELD43, NMFIELD44, NMFIELD45, NMFIELD46, NMFIELD47,
NMFIELD48, DSFIELD04, NMFIELD49, NMFIELD50, NMFIELD51, NMFIELD52, NMFIELD53,
NMFIELD54, NMFIELD55, NMFIELD56, DSFIELD05, NMFIELD57, NMFIELD58, NMFIELD59,
NMFIELD60, NMFIELD61, NMFIELD62, NMFIELD63, NMFIELD64, NMFIELD65, NMFIELD66,
NMFIELD67, DSFIELD06, NMFIELD68, NMFIELD69, NMFIELD70, NMFIELD71, NMFIELD72,
NMFIELD73, NMFIELD74, NMFIELD75, NMFIELD76, NMFIELD77, NMFIELD78, DSFIELD07,
NMFIELD79, NMFIELD80, NMFIELD81, NMFIELD82, NMFIELD83, NMFIELD84, NMFIELD85,
NMFIELD86, NMFIELD87, NMFIELD88, NMFIELD89, NMFIELD90, NMFIELD91, DSFIELD08,
NMFIELD92, NMFIELD93, NMFIELD94, DSFIELD09, NMFIELD95, NMFIELD96, NMFIELD97,
NMFIELD98, NMFIELD99, NMFIELD100) VALUES (1, 1, 129, 1, 1, NULL, 'TR-EXEC',
'Execution training', '02.2.0', '01.1', 'ELN', 'Team-plan', 'Team-exec', 1,
'Instructor', 1, NULL, 'Support Staff', 'Objective', 'Comments', NULL, NULL, NULL,
'2017-08-04', NULL, '012:00', 1, 1, 1, 1, '2017-08-04', NULL, 1, 1, 'SIGNATURE
NAME', 1, 1, 'TEST01', 'TEAM01', 5, 1, 1, 'Pre train comments', 1, 2, '5.00',
'50.00', 'TEST02', 'TEAM02', 10, 2, 1, 1, 'Training comments', 1, 1, 'SURVEY01',
'TEAM01', 15, 3, 1, 1, 'Reaction comments',1, 1, '6.00', 'TEST03', 'TEAM03', 15, 4,
10, 3, 1, 1, 'Post train comments',1, 1, '7.00', 'SURVEY02', 'TEAM02', 20, 1, 50, 1,
1, 1, 'Effectiveness comments',2, 'CAL1', 2, NULL, NULL, '1;1;1;1;1;2;2', 1, 2, 2,
50, 1, 'User', 1, 2, 'Verification method', NULL, NULL, NULL, NULL, 2, 500, '2017-
08-05', 2, 1, 500, 4);

Integration guide — SE Suite 2.0

 Integration via web services 304

Chapter V

Integration via web services

The Overview technician section, contains the necessary information to authenticate and communicate with
the SE Suite Web Services.

The Published Web services define all the Web Services published in the system, and what should be filled in
each one of them. It also contains an example of a client using the Java language.

IMPORTANT!

§ The use of integration via web services is not recommended to load large volumes of data.

§ It is recommended the creation of a specific user in the SE Suite to perform the integration via web services. This user

must have a license "Manager", it should not be synchronized with the AD and should not be used to access the
system on a daily basis, as it should be for the exclusive use for the integrations. That way it simplifies both the
management of the access permissions of that user to the integrations made available and the maintenance of the
history of performed integrations, which may be extracted by observing the records created by that user.

Integration guide — SE Suite 2.0

 Integration via web services 305

5.1 - Technical overview

As an alternative for system integration, SoftExpert makes available several integration interfaces, following
the specification for SOAP Web Services. All services available in SE Suite are described in detail in this
document, providing knowledge and enabling the creation of integrations by third parties.

To provide ever greater aid in the creation of integrations, two JAVA classes are made available for each
service, one for service request and another one for service return, using Apache Axis 2 library. The path of the
classes for view is detailed in each service.

Authentication and communication

For authentication of Web Services Java or PHP, will be used the same resources made available by SE Suite for
login. Such authentication will be made through a servlet made available for that end, which will also be
responsible for redirecting the call to the final destination, the web service.

The component used to communicate with the Web services is compatible with SOAP 1.2.

The Web Service will be called through servlet http://<host>:<port>/softexpert/webserviceproxy. The

host and port correspond to the server where SE Suite is installed. The Authentication process will be
performed using the Basic HTTP type. See more details in the Basic HTTP authentication section.

Integration guide — SE Suite 2.0

 Integration via web services 306

5.1.1 - Basic HTTP authentication

Must make the request to webserviceproxy passing on the header of the request Authorization parameter,
containing the word value Basic, the value " " (blank space) and the user login and the password separated
by the ":" (two dots) separator in the base64:

Authorization = Basic base64encode(<domain>\<user>:<password>)

The SE Suite default domain is "SE Suite". However, if using authentication via AD, the domain ID # must be used -
which is the same domain entered in the authentication server configuration in SE Configuration.

Example of user "se" and password "1":

Authorization = Basic c2U6MQ==

Score: For the draft of the php file of connection, it is necessary to insert through a tag location the WSDL
address for the connection as in the example below:

// WSDL URL
$wsdl = "http://$server/se/ws/dc_ws.php?wsdl";
$location = "http://$server/softexpert/webserviceproxy/se/ws/contnet.php";

// Instantiates a SOAP client

$client = new SoapClient($wsdl,array(
"trace" => 1, // Enables the trace
"exceptions" => 1, // Treats the exceptions
"login" => $user,
"password" => $pass,
"stream_context"=>stream_context_create($context),
"location" => $location
));

Integration guide — SE Suite 2.0

 Integration via web services 307

5.2 - Published web services

This section will display the published Web Services. See the following sections:

§ Administration

§ Asset

§ Calibration

§ Document

§ Generic

§ Incident

§ Inspection

§ Maintenance

§ PDM

§ Performance

§ Physical file

§ Problem

§ Project

§ Request

§ SPC

§ Supply

§ Time control

§ Workflow

Integration guide — SE Suite 2.0

 Integration via web services 308

5.2.1 - Administration

Web Services

WSDL URL: https://<domain>/se/ws/adm_ws.php?wsdl

Web Service URL: https://<comain>/softexpert/webserviceproxy/se/ws/adm_ws.php

This section displays the interfaces available for SE Administration. To insert each of these items, it will be
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

addAttribProfileValue Edits the values of the employee profile attributes

addAttribute Inserts attribute

addAttributeValue Inserts values to attributes

addCompany Inserts companies (customers, manufacturers, suppliers)

addCompContact Inserts company contacts

addMeasUnity Inserts and edits measurement units

addUserDepartment Inserts user; if it exists, edits it

changePositionStatus Enables/Disables position

compAtribAssoc Associates attribute values with companies

deleteCompany Deletes companies

deleteCompContact Deletes company contacts

deleteDepartment Deletes department

deleteMeasUnity Deletes measurement units

deleteUser Deletes a user

deleteUserAccessGroup Deletes relationship between user and access group

deleteUserDepartment Deletes relationship between user, department, and position

deleteUserLeader Deletes the leader associated with a user

disableUser Disables/enables a user

editDepartment Edits department

editPosition Edits position

editUser Inserts relationship between user, department, and position

Integration guide — SE Suite 2.0

 Integration via web services 309

Method Description

editUserDepartment Edits the relationship between user, department, and position

getAttribData Searches for the data of an attribute

newDepartment Inserts department

newPosition Inserts position

newUser Edits user; if it does not exist, returns an error.

updateEmployeeProfile Edits the employee profile data

Integration guide — SE Suite 2.0

 Integration via web services 310

5.2.1.1 - addAttribProfileValue

This method enables to add/edit:

§ Values of the employee profile attributes

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\admin\AddAttribProfileValueRequestType.java

Return web\wwwroot\ws\java\admin\AddAttribProfileValueResponseType.java

Request

ID # Required Description

IDUSER X Employee ID #.

NMATTRIBUTE X Attribute ID #

DSATTRIBUTE X1 Attribute value (Non-discrete, memo)

Attribute value.

Standards to enter date type data:

VLATTRIBUTE X2
§ dd/mm/yyyy

§ yyyy-mm-dd.

X 1 - Required when the attribute type is MEMO and the attribute type is INDETERMINATE.

X 2 - Required whenever the DSATTRIBUTE is not required.

Return

ID # Description

SUC C ESS: 1.
return
Failure: message describing the error.

Integration guide — SE Suite 2.0

 Integration via web services 311

5.2.1.2 - AddAttribute

This method enables to add/edit:

§ Attribute data

To insert each of these items, it is necessary to follow the standard documented below:

Java class

Request web\wwwroot\ws\java\admin\AddAttributeRequestType.java

Return web\wwwroot\ws\java\admin\AddAttributeResponseType.java

Request

ID # Required Description

IDATTRIBUTE X Attribute ID #.

NMATTRIBUTE X Attribute name.

IDUSER X User ID #.

Attribute type [1 - List of values (discrete); 2 - Non-

FGATTRIBUTETYPE X
discrete; 3 - External].

Attribute data type: [1 - Text, 2 - Numeric, 3 - Date, 4 -

FGDATATYPE X
Memo, 5 - C urrency].

FGSELEC TIONTYPE X Selection mode [1 - Zoom; 2 - C ombo].

FGMULTIVALUED Multivalued attribute [1 - Yes; 2 - No].

C ode of the SE Suite component in which the attribute will

C DISOSYSTEM
be associated (separated by \";\"). Example:109;107.

FGMASKTYPE Mask type [1 - Simple mask; 2 - Regular expression]

DSMASK Mask

Return

ID # Description

SUC C ESS: an attribute is created;

return
FAILURE: message for the error that occurred;

Integration guide — SE Suite 2.0

 Integration via web services 312

5.2.1.3 - addAttributeValue

This method enables to add/edit:

§ Attribute values

To insert each of these items, it is necessary to follow the standard documented below

Java class

Request web\wwwroot\ws\java\admin\AddAttribValueRequestType.java

Return web\wwwroot\ws\java\admin\AddAttribValueResponseType.java

Request

ID # Required Description

IDATTRIBUTE X Attribute ID #.

VLATTRIBUTE X1 Attribute value.

FGDEFAULTVALUE X1 Use as default: [1 - Yes, 2 - No].

IDUSER X User ID #.

IDDATASOURC E X2 Data source ID #.

DSC ONNDBSQL X2 SQL.

NMFILTERFIELD X2 Search field.

X 1 - Required when the attribute type is “List of values”.

X 2 Required when the attribute type is “External”.

Return

ID # Description

SUC C ESS: an attribute value is created.

return
FAILURE: message for the error that occurred;

Integration guide — SE Suite 2.0

 Integration via web services 313

5.2.1.4 - AddCompany

This method enables to add/edit:

§ Data of companies;

§ Add customers, manufacturers, suppliers;

To insert each of these items, it is necessary to follow the standard documented below.

This method enables to associate attribute values with companies. To insert each of these items, it is
necessary to follow the standard documented below:

Java class

Request web\wwwroot\ws\java\admin\AddCompanyRequestType.java

Return web\wwwroot\ws\java\admin\AddCompanyResponseType.java

Request

ID # Required Description

idcommercial X C ompany ID.

nmcompany X C ompany name.

dsaddress Address.

nmcity C ity.

idstate State.

nmcountry C ountry.

idzipcode Postal code.

idphone Phone #.

idfax FAX #.

nmhomepage Home Page.

fgcustomer X C ustomer company: 1 – Yes; 2 - No.

fgsupplier X Supplier company: 1 – Yes; 2 - No.

fgmanufacturer X Manufacturer company: 1 – Yes; 2 - No.

dscompany Description.

idcompany C ompany code

idcompanytype X C ompany type ID #.

Integration guide — SE Suite 2.0

 Integration via web services 314

C ode of the SE Suite component which the company will be

cdisosystem
associated with (separated by ";"). Example:109;107.

Return

ID # Description

SUC C ESS: a company is created;

return
FAILURE: message for the error that occurred;

Integration guide — SE Suite 2.0

 Integration via web services 315

5.2.1.5 - AddCompContact

This method enables to add/edit:

Data of company contacts;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\admin\AddCompContactRequestType.java

Return web\wwwroot\ws\java\admin\AddCompContactResponseType.java

Request

ID # Required Description

IDC OMMERC IAL X C ompany ID.

NMC ONTAC T X C ontact name.

NMDEPARTMENT Department.

NMPOSITION Position.

IDPHONE Phone #.

IDFAX Fax #.

NMEMAIL E-mail.

DSC ONTAC T Description.

FGDEFAULT Use as default: [1 - Yes, 2 - No].

Return

ID # Description

SUC C ESS: company contact is created.

return
FAILURE: message for the error that occurred;

Integration guide — SE Suite 2.0

 Integration via web services 316

5.2.1.6 - AddMeasUnity

This method enables to add/edit:

§ Measurement unit data

To insert each of these items, it is necessary to follow the standard documented below:

Java class

Request web\wwwroot\ws\java\admin\AddMeasUnityRequestType.java

Return web\wwwroot\ws\java\admin\AddMeasUnityResponseType.java

Request

ID # Required Description

IDMEASUNITY X Measurement unit ID #

NMMEASUNITY X Measurement unit name

C ode of the SE Suite component which it will be associated

C DISOSYSTEM with (separated by ";" in case there is more than one
component to be associated). Example:109;107.

Return

ID # Description

SUC C ESS: a measurement unit is created;

return
FAILURE: message for the error that occurred;

Integration guide — SE Suite 2.0

 Integration via web services 317

5.2.1.7 - AddUserDepartment

This method enables to add a relationship between user, department and position. For this addition, it is
necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\admin\AddUserDepartmentRequestType.java

Return web\wwwroot\ws\java\admin\AddUserDepartmentResponseType.java

Request

ID # Required Description

ID X User ID number

IDAREA X Department ID #.

IDFUNC X Position ID #.

Return

ID # Description

SUC C ESS: Primary key of the user(C DUSER)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 318

5.2.1.8 - ChangePositionStatus

This method enables to edit the status of a position from disabled to enabled and vice versa. For this
operation, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\admin\ChangePositionStatusRequestType.java

Return web\wwwroot\ws\java\admin\ChangePositionStatusResponseType.java

Request

ID # Required Description

ID X Position ID #

Return

ID # Description

SUC C ESS: Primary key of the position(C DPOSITION)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 319

5.2.1.9 - compAtribAssoc

This method enables to associate attribute values with companies. To insert each of these items, it is
necessary to follow the standard documented below:

Java class

Request web\wwwroot\ws\java\admin\CompAtribAssocRequestType.java

Return web\wwwroot\ws\java\admin\CompAtribAssocResponseType.java

Request

ID # Required Description

IDC OMMERC IAL X C ompany ID

IDATTRIBUTE X Attribute ID #

VLATTRIBUTE X Attribute value

Return

ID # Description

SUC C ESS: an attribute value is created.

return
FAILURE: message for the error that occurred;

Integration guide — SE Suite 2.0

 Integration via web services 320

5.2.1.10 - DeleteCompany

This method enables to delete companies. To delete each of these items, it is necessary to follow the standard
documented below.

Java class

Request web\wwwroot\ws\java\admin\DeleteCompanyRequestType.java

Return web\wwwroot\ws\java\admin\DeleteCompanyResponseType.java

Request

ID # Required Description

IDC OMMERC IAL X C ompany ID

NMC OMPANY X C ompany name

Return

ID # Description

SUC C ESS: a company is deleted;

return
FAILURE: message for the error that occurred;

Integration guide — SE Suite 2.0

 Integration via web services 321

5.2.1.11 - DeleteCompContact

This method enables to delete company contacts. To delete each of these items, it is necessary to follow the
standard documented below.

Java class

Request web\wwwroot\ws\java\admin\DeleteCompContactRequestType.java

Return web\wwwroot\ws\java\admin\DeleteCompContactResponseType.java

Request

ID # Required Description

IDC OMMERC IAL X C ompany ID.

NMC ONTAC T X C ontact name.

Return

ID # Description

SUC C ESS: company contact is deleted.

return
FAILURE: message for the error that occurred;

Integration guide — SE Suite 2.0

 Integration via web services 322

5.2.1.12 - DeleteDepartment

This method enables to delete a department. To delete it, it is necessary to follow the standard documented
below.

Java class

Request web\wwwroot\ws\java\admin\DeleteDepartmentRequestType.java

Return web\wwwroot\ws\java\admin\DeleteDepartmentResponseType.java

Request

ID # Required Description

ID X Department ID #

Return

ID # Description

SUC C ESS: Primary key of the department (C DDEPARTMENT)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 323

5.2.1.13 - DeleteMeasUnity

This method enables to delete measurement units. To delete each of these items, it is necessary to follow the
standard documented below.

Java class

Request web\wwwroot\ws\java\admin\DeleteMeasUnityRequestType.java

Return web\wwwroot\ws\java\admin\DeleteMeasUnityResponseType.java

Request

ID # Required Description

IDMEASUNITY X Measurement unit ID #

Return

ID # Description

SUC C ESS: a measurement unit is deleted;

return
FAILURE: message for the error that occurred;

Integration guide — SE Suite 2.0

 Integration via web services 324

5.2.1.14 - DeleteUser

This method enables to delete a user. To delete it, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\admin\DeleteUserRequestType.java

Return web\wwwroot\ws\java\admin\DeleteUserResponseType.java

Request

ID # Required Description

ID X User ID number

Return

ID # Description

SUC C ESS: Primary key of the user (C DUSER)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 325

5.2.1.15 - DeleteUserAcessGroup

This method enables to delete a relationship between the user and access group. For this deletion, it is
necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\admin\DeleteUserDepartmentAcessGroupRequestType.jav
Request
a

Return web\wwwroot\ws\java\admin\DeleteUserAcessGroupResponseType.java

Request

ID # Required Description

ID X User ID #.

IDAC C GROUP X Access group ID #.

Return

ID # Description

SUC C ESS: Primary key of the access user (C DGROUP)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 326

5.2.1.16 - DeleteUserDepartment

This method enables to delete a relationship between the user, department, and position. For this deletion, it
is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\admin\DeleteUserDepartmentRequestType.java

Return web\wwwroot\ws\java\admin\DeleteUserDepartmentResponseType.java

Request

ID # Required Description

ID X User ID #.

IDAREA X Department ID #.

IDFUNC X Position ID #.

Return

ID # Description

SUC C ESS: Primary key of the user(C DUSER)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 327

5.2.1.17 - deleteUserLeader

This method enables to delete the leader associated with a user. To use it, it is necessary to follow the
standard documented below.

Java class

Request web\wwwroot\ws\java\admin\ DeleteUserLeaderRequestType.java

Return web\wwwroot\ws\java\admin\DeleteUserLeaderResponseType.java

Request

ID # Required Description

ID X User ID number

Return

ID # Description

SUC C ESS: Primary key of the user (C DUSER)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 328

5.2.1.18 - disableUser

This method enables to disable/enable a user. To use it, it is necessary to follow the standard documented
below.

Java class

Request web\wwwroot\ws\java\admin\DisableUserRequestType.java

Return web\wwwroot\ws\java\admin\DisableUserResponseType.java

Request

ID # Required Description

C ode of the users to be disabled/enabled, separated by ‘;’

The user code to be disabled can be verified in the
C ODES X
database. (Ex: SELEC T cduser FROM aduser WHERE idlogin
= 'user id')

Return

ID # Description

SUC C ESS: 0 (The users should be disabled/enabled.)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 329

5.2.1.19 - EditDepartment

This method enables to edit the data of a department. To edit these data, it is necessary to follow the
standard documented below.

Java class

Request web\wwwroot\ws\java\admin\EditDepartmentRequestType.java

Return web\wwwroot\ws\java\admin\EditDepartmentResponseType.java

Request

ID # Required Description

ID X Department ID #

DESC X Department description

IDUPPER Upper level department ID #

IDC OMPANY ID # of the company where the department is defined

Return

ID # Description

SUC C ESS: Primary key of the department(C DDEPARTMENT)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 330

5.2.1.20 - EditUser

This method enables to edit the data of a user. To edit it, it is necessary to follow the standard documented
below.

Java class

Request web\wwwroot\ws\java\admin\EditUserRequestType.java

Return web\wwwroot\ws\java\admin\EditUserResponseType.java

Request

ID # Required Description

ID X User ID number

NAME X User name.

LOGIN X Name used by the user to log into the system

PASS X User password.

EMAIL User e-mail address.

C DLEADER Leader ID #.

Return

ID # Description

SUC C ESS: Primary key of the user (C DUSER)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 331

5.2.1.21 - editUserDepartment

This method enables to edit the relationship between the user, department, and position associated with a
user. If the user already has a default department, it will be replaced and the new one will be considered the
default. To use it, it is necessary to follow the standard documented below

Java class

Request web\wwwroot\ws\java\admin\EditUserDepartmentRequestType.java

Return web\wwwroot\ws\java\admin\EditUserDepartmentResponseType.java

Request

ID # Required Description

ID X User ID number

IDAREA X Department ID #.

IDFUNC X Position ID #.

Return

ID # Description

SUC C ESS: Primary key of the user (C DUSER)

return
FAILURE: -1.

Integration guide — SE Suite 2.0

 Integration via web services 332

5.2.1.22 - getAttribData

This method enables to search for the data of an attribute. To use it, it is necessary to follow the standard
documented below.

Java class

Request web\wwwroot\ws\java\admin\GetAttribDataRequestType.java

Return web\wwwroot\ws\java\admin\GetAttribDataResponseType.java

Request

ID # Required Description

Attribute ID # (there may be more than one).

IDATTRIBS X
Example:"Attribute1,Attribute2,Attribute3"

Return

ID # Description

SUC C ESS: An array should be returned with the following attribute information:

§ C DATTRIBUTE: Attribute code

§ NMATTRIBUTE: Attribute ID#

§ FGDATATYPE: Attribute data type: [1 - Text, 2 - Numeric, 3 - Date, 4 - Memo, 5 -

C urrency]
return
§ FGATTRIBUTETYPE: Attribute type

§ NMLABEL: Attribute label

§ FGMULTIVALUED: Multivalued attribute [1 - Yes; 2 - No]

§ VALUE: List of attribute values

FAILURE: Return empty.

Integration guide — SE Suite 2.0

 Integration via web services 333

5.2.1.23 - NewDepartment

This method enables to insert the data of a department. For this addition, it is necessary to follow the
standard documented below.

Java class

Request web\wwwroot\ws\java\admin\NewDepartmentRequestType.java

Return web\wwwroot\ws\java\admin\NewDepartmentResponseType.java

Request

ID # Required Description

ID X Department ID #

DESC X Department description

IDPOS X ID # of the default position to be defined in the department

IDUPPERr Upper level department ID #

IDC OMPANY ID # of the company where the department is defined

Return

ID # Description

SUC C ESS: Primary key of the department(C DDEPARTMENT)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 334

5.2.1.24 - NewPosition/EditPosition

This method enables to insert/edit the data of a position. For this insertion/editing, it is necessary to follow the
standard documented below.

Java class

web\wwwroot\ws\java\admin\NewPositionRequestType.java
Request
web\wwwroot\ws\java\admin\EditPositionRequestType.java

web\wwwroot\ws\java\admin\NewPositionResponseType.java
Return
web\wwwroot\ws\java\admin\EditPositionResponseType.java

Request

ID # Required Description

ID X Position ID #.

DESC X Position description.

Return

ID # Description

SUC C ESS: Primary key of the position(C DPOSITION)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 335

5.2.1.25 - NewUser

This method enables to add/edit:

§ Data of a user;

§ Relationship between user, department, and position;

§ Relationship between user and access group.

If the user already exists and the department being entered is different from the one the user is already
associated with, the new department will be associated and considered as the default.

If the user already exists and a field is changed with the same department and function already registered,
the system will return an error informing that the user is already being used by this department and function.
To perform an audition, it should be informed in white the IDAREA and IDFUNC identifiers. If the objective is to
change the department and function, IDARE and IDFUNC can be informed so that the system can make this
change.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\admin\NewUserRequestType.java

Return web\wwwroot\ws\java\admin\NewUserResponseType.java

Request

ID # Required Description

IDUSER X User ID number

NAME X User name.

LOGIN X Name used by the user to log into the system

PASS X User password.

EMAIL User e-mail address.

IDAREA Department ID #.

IDFUNC Position ID #.

IDAC C GROUP Access group ID #.

C DLEADER Leader ID #.

Integration guide — SE Suite 2.0

 Integration via web services 336

Return

ID # Description

SUC C ESS: Primary key of the user (C DUSER)

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 337

5.2.1.26 - updateEmployeeProfile

This method enables to edit:

§ Educational level;

§ Educational level status;

§ Birth date;

§ Hire date;

§ Termination date;

§ Comments;

§ Address.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web/wwwroot/ws/java/administration/UpdateEmployeeProfileRequestType.jav
Request
a

web/wwwroot/ws/java/administration/UpdateEmployeeProfileResponseType.ja
Return
va

Request

ID # Required Description

IDUSER X User's reg. code #.

IDEDULEVEL ID # of educational level

Educational level status;

1 - C omplete;
FGEDULEVELSTATUS
2 - Unfinished;

* Mandatory when the educational level is changed.

DTBIRTHDAY Birth date

DTADMISSION Hire date

DTDEMISSION Termination date

DSADDRESS Address

DSOBS C omments

Integration guide — SE Suite 2.0

 Integration via web services 338

Return

ID # Description

SUC C ESS: 1
return
Failure: Message describing the error.

The values accepted for the import of dates must follow one of the following standards:

§ YYYY-MM-DD

§ DD/MM/YYYY

Integration guide — SE Suite 2.0

 Integration via web services 339

5.2.2 - Asset

Web Services

WSDL URL: https://<domain>/<sesuite_directoy>/ws/ast_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/ast_ws.php

This section displays the interfaces available for SE Asset. To insert each of these items, it will be necessary to
follow the standard documented in the upcoming sections.

Available web services

Method Description

del_objectType Deletes an asset type

delete_assetConfSite Deletes a storage place

import_asset C reates or edits an asset

import_asset_oee Insertion of the parameters data to calculate OEE

import_asset_site Associates a location with the asset

import_asset_state Edits the asset condition

import_asset_status Enable/disables the asset.

import_asset_structure_insert_update Defines or edits a structure for the asset.

import_assetConfSite C reates a storage place

import_attrib_assoc Associates an attribute with the asset

import_del_asset Deletes an asset

import_del_asset_site Deletes an asset location

import_del_asset_state Deletes an asset condition

Import_del_asset_structure Deletes a structure of the asset

import_objectSecurity C reates security types for an asset

import_objectType C reates or edits an asset type

C reates or edits a plan of verification, preventive

importPlanActivity
maintenance or calibration

Integration guide — SE Suite 2.0

 Integration via web services 340

5.2.2.1 - del_objectType

This method enables to delete an asset type.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Del_objectTypeRequestType.java

Return web\wwwroot\ws\java\asset\Del_objectTypeResponseType.java

Request

ID # Required Description

IDOBJEC TTYPE X Object type ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 341

5.2.2.2 - delete_assetConfSite

This method enables to delete:

§ Data of a storage place;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Delete_assetConfSiteRequestType.java

Return web\wwwroot\ws\java\asset\Delete_assetConfSiteResponseType.java

Request

ID # Required Description

IDSITE X Storage place ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 342

5.2.2.3 - import_asset

This method enables to insert and edit:

§ Data of an asset;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_assetRequestType.java

Return web\wwwroot\ws\java\asset\Import_assetResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

NMOBJEC T X Asset name.

IDOBJEC TTYPE X Asset type ID #.

IDTEAM X Responsible team ID #.

Asset specification:
1 - Gage;
2 - Equipment;
FGAPPLIC ATION X 4 - Others;
6 - Tooling;
7 – Tools;

11 – C omputer.

DTSTARTOPER X Operation start date.

QUANTITY X Asset quantity

C AVITY C avity (required for "Tooling").

MANUFAC TURER Manufacturer (company name).

IDSERIALNUMBER Serial number.

IDMODEL Template.

IDC ALENDAR X C alendar ID #.

SUPPLIER Supplier (company name).

VLEQUIPMENTC OST Equipment cost.

Integration guide — SE Suite 2.0

 Integration via web services 343

VLC OST Hourly cost.

Asset attributes. Example:

Attribute_ID=value1_of_attribute,value2_of_attribute,value
3_of_attribute.
Note:
ATTRIBUTES
§ For attributes with numeric values, the
decimal place separator must be ‘.’ (point).

§ For date fields, the value must have the format “Y-
MD”(Year-Month-Day).

DSDESC RIPTION Description

C HARAC TERISTIC S C haracteristics

DSOBSERVATION C omments

Return

ID # Description

SUC C ESS: Return regarding the executed item

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 344

5.2.2.4 - import_asset_oee

This import template enables to add:

§ Parameter data to calculate OEE

To insert the data, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_asset_oeeRequestType.java

Return web\wwwroot\ws\java\asset\Import_asset_oeeResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

DTSTART X Start date.

DTEND X End date

QTQUALITY X Quality parts

QTTOTAL X Total parts

QTPRODUC ED X Amount produced

QTPLANNED X Planned quantity

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 345

5.2.2.5 - import_asset_site

This method enables to associate:

§ Data of a location with an asset

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_asset_siteRequestType.java

Return web\wwwroot\ws\java\asset\Import_asset_siteResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

Asset location data. Note: it cannot be after the current

DATE X
date

HOUR X Asset location time

Location type:

1 - Location,
TYPE X
2 - User,

3 - Location/User

LOC ATION X1 Location ID #.

USER X1 User ID #.

C OMMENTS Asset location comments.

§ X¹ - Required according to the location type

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 346

5.2.2.6 - import_asset_state

This method enables to add/edit:

§ Data of a condition of the asset;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_asset_stateRequestType.java

Return web\wwwroot\ws\java\asset\Import_asset_stateResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

DTSTATE X Asset condition date

TMSTATE X Asset condition time

IDSTATE X Asset condition ID #

DSOBSERVATION C omments

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 347

5.2.2.7 - import_asset_status

This method allows enabling/disabling:

§ Status of an asset;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_asset_statusRequestType

Return web\wwwroot\ws\java\asset\Import_asset_statusResponseType

Request

ID # Required Description

IDOBJEC T X Asset ID #

Asset status;

FGASSTATUS X 1 – Enable;

2 – Disable.

C ancel asset reservation(s):

RESERVE X 1 – Yes;

2 – No.

DSJUSTIFY X Explanation

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 348

5.2.2.8 - import_asset_structure_insert_update

This method enables to define or edit a structure for the asset.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\asset\Import_asset_structure_insert_updateRequestTy
Request
pe.java

web\wwwroot\ws\java\asset\Import_asset_structure_insert_updateResponseT
Return
ype.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

IDREVISION X Revision ID #

IDBOBJEC TC HILD X Asset ID # (lower level)

IDREVISIONC HILD X Revision ID # (lower level)

VLQUANTITY X Quantity

Object specification (C onsidered as 1 by default):

FGAPPLIC ATION 1 - Asset;

2 - Supply.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 349

5.2.2.9 - import_assetConfSite

This method enables to insert and edit:

§ Data of a storage place;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_assetConfSiteRequestType.java

Return web\wwwroot\ws\java\asset\Import_assetConfSiteResponseType.java

Request

ID # Required Description

IDSITE X Storage place ID #

NMSITE X Storage place name

1 - Enabled
FGENABLED X
2 - Disabled

IDSITEOWNER Upper level storage place

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 350

5.2.2.10 - import_attrib_assoc

This method enables the association of an asset with an attribute.

To associate the attributes successfully, it is necessary follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_attrib_assocRequestType.java

Return web\wwwroot\ws\java\asset\Import_attrib_assocResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #.

IDATTRIBUTE X Attribute ID #

Attribute value.
Defaults for the input of date type data:
VALUE X
- dd/mm/yyyy;
- yyyy-mm-dd.

IDREVISION Asset revision ID #.

If the value 1 is entered, the interface will verify whether

FGINSERTLISTVALUE the attribute value already belongs to the list of values. If it
does not exist, it will be added.

Attribute value. Mandatory information if the type of the

DSATTRIBUTE
attribute value is MEMO.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 351

5.2.2.11 - import_del_asset

This method enables to delete:

§ Data of an asset;

To delete each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_del_assetRequestType.java

Return web\wwwroot\ws\java\asset\Import_del_assetResponseType.java

Request

ID # Required Description

IDBOJEC T X Asset ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 352

5.2.2.12 - import_del_asset_site

This method enables to remove:

§ Data of the last location of the asset

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_del_asset_siteRequestType.java

Return web\wwwroot\ws\java\asset\Import_del_asset_siteResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 353

5.2.2.13 - import_del_asset_state

This method enables to delete:

§ Data of a condition of the asset;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_del_asset_stateRequestType.java

Return web\wwwroot\ws\java\asset\Import_del_asset_stateResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 354

5.2.2.14 - Import_del_asset_structure

This method enables to delete a structure of the asset.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_asset_del_structureRequestType.java

Return web\wwwroot\ws\java\asset\Import_asset_del_structureResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

IDREVISION X Revision ID #

IDOBJEC TC HILD X Asset ID # (lower level)

IDREVISIONC HILD X Revision ID # (lower level)

Object specification (C onsidered as 1 by default):

FGAPPLIC ATION X 1 - Asset;

2 - Supply.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 355

5.2.2.15 - import_objectSecurity

This method enables to insert and edit:

§ Data of a security type

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_objectSecurityRequestType.java

Return web\wwwroot\ws\java\asset\Import_objectSecurityResponseType.java

Request

ID # Required Description

IDOBJEC TTYPE X Object type ID #

Access control type:

1 - Group of users,

2 - Department,

AC C ESSTYPE X 3 - Department/Position,

4 - Position,

5 - User,

6 - All

Permission type:

PERMISSION X 1 - Allow,

2 - Deny

Access type ID #.
IDAC C ESSTYPE X Example: If the type is by user, it will be the user ID. If the
type is by department, it will be the department ID #.

Position ID #. This field will only be used if the type is by

IDFUNC TION X² department and position. That way, the department will go
in the IDAC C ESSTYPE field and the position, in this one.

C ontrol to add:

INSERT X1 1 - Yes,

2 - No

Integration guide — SE Suite 2.0

 Integration via web services 356

C ontrol to edit:

EDIT X1 1 - Yes,

2 - No

C ontrol to delete:

DELETE X1 1 - Yes,

2 - No

Security control:

SEC URITY X1 1 - Yes,

2 - No

Listing control:

LIST X1 1 - Yes,

2 - No

View control:

VIEW X1 1 - Yes,

2 - No

§ X¹ - Required at least one control field

§ X² - Required when IDAC C ESSTYPE is equal to 2.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 357

5.2.2.16 - import_objectType

This method enables to insert and edit:

§ Data of an asset type;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\Import_objectTypeRequestType.java

Return web\wwwroot\ws\java\asset\Import_objectTypeResponseType.java

Request

ID # Required Description

IDOBJEC TTYPE X Object type ID #

NMOBJEC TTYPE X Name of the object type

Flag to identify whether the class will, or not, have a

revision:
FGUSEREVISIONOBJTYPE X
1 - Yes,

2 - No

Flag to identify whether a mask will be used for

numbering:
FGUSEMASK X
1 - Yes,

2 - No

IDMASK Mask ID #

Revision ID # type:

1 - Text

FGEDITID 2 - Numeric

3 - C ustomized

Will be required if the is 1

Revision ID #. Will be required if the

FGREVIDOBJTYPE
FGUSEREVISIONOBJTYPE is 1

Revision approval mode; it will be required if

FGREVAPPROVALMODEOBJTYPE
FGUSEREVISIONOBJTYPE is 1

Revision closure mode; it will be required if

FGREVRELEASEMODEOBJTYPE
FGUSEREVISIONOBJTYPE is 1

Integration guide — SE Suite 2.0

 Integration via web services 358

Retention quantity of obsolete revisions; it will be

QTREVRETENTIONOBJTYPE
required if FGUSEREVISIONOBJTYPE is 1

Retention frequency of obsolete revisions; it will be

FGREVRETENTIONMODEOBJTYPE
required if FGUSEREVISIONOBJTYPE is 1

Route type; it will be required if

FGREVROUTETYPEOBJTYPE
FGUSEREVISIONOBJTYPE is 1

Acceptance of revision in the draft step. Will be

FGREVELABC LAUSEOBJTYPE
required if the FGUSEREVISIONOBJTYPE is 1

Acceptance of revision in the review step. Will be

FGREVC ONSC LAUSEOBJTYPE
required if the FGUSEREVISIONOBJTYPE is 1

Acceptance of revision in the approval step. Will be

FGREVAPROVC LAUSEOBJTYPE
required if the FGUSEREVISIONOBJTYPE is 1

Acceptance of revision in the release step; it will be

FGREVHOMOLOGC LAUSEOBJTYPE
required if FGUSEREVISIONOBJTYPE is 1

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 359

5.2.2.17 - importPlanActivity

This method enables to insert and edit:

§ Data from a verification plan, preventive maintenance or calibration;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\asset\ImportPlanActivityRequestType.java

Return web\wwwroot\ws\java\asset\ImportPlanActivityRequestType.java

Request

ID # Required Description

Action option:

FGOPTION X 21 – Add;

22 – Edit;

Plan type:

1 – Verification;
FGPLANTYPE X¹
2 – Preventive maintenance;

3 – C alibration.

IDPLANAC TIVITY X Plan ID #

NMPLANAC TIVITY X¹ Plan name

IDMODELAC TIVITY X¹ Standard activity ID #

Plan configuration:

FGPLANC ONF X¹ 1 – Inherit activity data;

2 – C opy activity data.

Asset ID #. For multiple assets separate the identifiers with

IDASSET X¹ semicolons.

E.g.: IDATIVO01;IDATIVO02;IDATIVO03

IDTEAM X¹ Responsible team ID # for plan

IDTEAMPROG X² Responsible team ID # for planning

IDTEAMEXEC X² Responsible team ID # for execution

Date-based frequency:
FGDATEFREQUENC Y
1 – Enable;

Integration guide — SE Suite 2.0

 Integration via web services 360

2 – Disable.

Frequency type:

1 – Execution date;
FGFREQTYPE X³
2 – First use;

3 – Usage time.

QTFREQUENC E X³ Frequency

Frequency unit:

1 – Day(s);

2 – Week(s);
FGFREQUNIT X³
3 – Month(s);

4 – Year(s);

5 – Working day(s).

Date visualization:

FGDATEVIEW X³ 1 – Month/Day/Year;

2 – Month/Year.

DTNEXTEXEC UTION X³ Date of the next execution (format Y-m-d)

IDC ALENDAR C alendar ID #.

Frequency based on asset meter:

FGMETERFREQUENC Y 1 – Enable;

2 – Disable.

VLMETERFREQUENC Y x4 Frequency

VLANTEC IPATION x4 Anticipation

VLNEXTEXEC UTION x4 Next execution

C reate activity automatically:

FGAUTOC REATE 1 – Enable;

2 – Disable.

Activity step created automatically:

FGAUTOSTATUS x5 1 – Planning;

2 – To be started.

Number of days that the automatic activity will be created

QTDAYBEFORE x5
previously

§ X¹: Required when inserting.

§ X²: Required when inserting if the plan configuration is copy of (FGPLANC ONF = 2).

§ X³: Required if the frequency based in dates is enabled (FGDATEFREQUENC Y = 1).

Integration guide — SE Suite 2.0

 Integration via web services 361

§ X4: Required if the frequency based in meters is enabled (FGMETERFREQUENC Y = 1).

§ X5: Required if the option to create an activity automatically is enabled (FGAUTOC REATE = 1).

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 362

5.2.3 - Calibration

Web Services

WSDL URL: https://<domain>/se/ws/cl_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/cl_ws.php

This section displays the interfaces available for SE Calibration. To insert each of these items, it will be
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

import_calibration C reates or edits a calibration

import_del_calibration Deletes a calibration

import_point C reates calibration results per point

import_table C reates calibration results per table

Integration guide — SE Suite 2.0

 Integration via web services 363

5.2.3.1 - import_calibration

This method enables to insert and edit:

§ Data of a calibration;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\calibration\Import_calibrationRequestType.java

Return web\wwwroot\ws\java\calibration\Import_calibrationResponseType.java

Request

ID # Required Description

IDPLANAC TIVITY X C alibration plan ID #

NRC ERTIFIC ATE X C ertificate #

DTSTART X Start date;

HRSTART X Start time;

DTFINISH X End date;

HRFINISH X End time;

SVC C ENTER X Service server;

Responsibility:
RESP X § Internal service center: User ID
§ Third-party service center: Name

AC TC LASSIFIC ATION Activity classification;

C alibration result (required if the calibration configuration

has no table and point)

C ALRESULT 1 - Approved;

2 - C onditionally approved;

3 - Rejected;

Pre-calibration result (required if the calibration

configuration has no table and point and uses the

PREC ALRESULT Schumacher method)

1 - Approved;

2 - Rejected;

Integration guide — SE Suite 2.0

 Integration via web services 364

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 365

5.2.3.2 - import_del_calibration

This method enables to delete:

§ Data of a calibration;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\calibration\Import_del_calibrationRequestType.java

Return web\wwwroot\ws\java\calibration\Import_del_calibrationResponseType.java

Request

ID # Required Description

NRC ERTIFIC ATE X C ertificate #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 366

5.2.3.3 - import_point

This method enables to create:

§ Results of calibration per point;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\calibration\Import_pointRequestType.java

Return web\wwwroot\ws\java\calibration\Import_pointResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

NRC ERTIFIC ATE X C ertificate #

NMTABLE X Table name

NMPOINT X Point name

In the case of hysteresis, it indicates whether the point is:

FGUPORDOWN X1 1- Rising

2- Descending

Indicates whether it is:

TYPE_VALUE X1 1- C alibration

2- Pre-calibration

VLTEND X1 Trend or systematic error value [Bias].

VLFGES X1 Total deviation value [Fges].

VLFE X1 Deviation value [Fe].

VLU95 X1 Expanded uncertainty value [U95].

VLERRUP X1 Ascending error value [Ascending error].

VLERRDOWN X1 Descending error value [Descending error].

VLBAND X1 Range error value [Range error].

VLAVERAGE X1 Average value [Average].

VLREADBIG X1 The highest reading value [The highest reading].

Integration guide — SE Suite 2.0

 Integration via web services 367

VLREADSMALL X1 The lowest reading value [the lowest reading].

VLHISTERESE X1 Hysteresis value [Hysteresis].

VLFT X FT value [FT].

IDPROC ESS X Process ID #;

Additional variable.

VARIABLE X Format: [variable ID]=VALUE;

[VARIABLE ID]=VALUE; Example: g=9.81; UPAD=0.01;

§ X 1 – Required according to the formula.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 368

5.2.3.4 - import_table

This method enables to create:

§ Results of calibration per table;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\calibration\Import_tableRequestType.java

Return web\wwwroot\ws\java\calibration\Import_tableResponseType.java

Request

ID # Required Description

IDOBJEC T X Asset ID #

NRC ERTIFIC ATE X C ertificate #

NMTABLE X Table name

Indicates whether it is:

TYPE_VALUE X 1- C alibration

2- Pre-calibration

VLTEND X1 Trend or systematic error value [Bias].

VLFGES X1 Total deviation value [Fges].

VLFE X1 Deviation value [Fe].

VLU95 X1 Expanded uncertainty value [U95].

VLERRUP X1 Ascending error value [Ascending error].

VLERRDOWN X1 Descending error value [Descending error].

VLBAND X1 Range error value [Range error].

VLAVERAGE X1 Average value [Average].

VLREADBIG X1 The highest reading value [The highest reading].

VLREADSMALL X1 The lowest reading value [the lowest reading].

VLHISTERESE X1 Hysteresis value [Hysteresis].

IDPROC ESS Process ID #;

Integration guide — SE Suite 2.0

 Integration via web services 369

Additional variable.

VARIABLE Format: [variable ID]=VALUE;

[VARIABLE ID]=VALUE; Example: g=9.81; UPAD=0.01;

C alibration result for subjective table:

RESULT 1 - Approved;

2 - Rejected;

Pre-calibration result for subjective table:

RESULTDI 1 - Approved;

2 - Rejected;

OBSERVATION Subjective table comments;

§ X 1 – Required according to the formula.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 370

5.2.4 - Document

Web Services

WSDL URL: https://<domain>/se/ws/dc_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/dc_ws.php

This section displays the interfaces available for SE Document. To insert each of these items, it will be
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

cancelDocument C ancels a document

checkAccessPermission C hecks whether the user has permission to a document

deleteAccessPermission Removes access permission to a specific document

deleteDocument Deletes a document

deleteRevision Deletes determined revision of a document

downloadEletronicFile Downloads an electronic file

editDocument Edits a document

getKeyWords Searches for keywords

getKeyWordsData Searches for keywords, their meaning, and synonyms

listAccessPermission Returns the access types the user has to a document

List of pending documents in the draft, review, approval, or release

listPendencyDocument
step

newAccessPermission Adds access permission to a determined document

newDocument C reates a document

newRevision C reates a new document revision

releasePendencyDocument Releases a user task

searchAccessAudit Search access audit

searchCategory Lists all the categories saved in the system

searchDocument Searches for documents

Integration guide — SE Suite 2.0

 Integration via web services 371

setAttributeValue Assigns a value to an attribute of a specific document

uploadEletronicFile Uploads an electronic file

viewDocumentData Recovers the data of a document

Integration guide — SE Suite 2.0

 Integration via web services 372

5.2.4.1 - cancelDocument

This method enables to cancel a document. To use it, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/document/CancelDocumentRequestType.java

Return web/wwwroot/ws/java/document/CancelDocumentResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

DSC ANC EL X C ancellation description.

Return

ID # Description

SUC C ESS: 1: Document cancelled successfully.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 373

5.2.4.2 - checkAccessPermission

This method enables to verify whether the user has permission to the document. To use it, it is necessary to
follow the standard documented below.

Java class

Request web/wwwroot/ws/java/document/CheckAccessPermissionRequestType.java

Return web/wwwroot/ws/java/document/CheckAccessPermissionResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

IDUSER X User ID #.

Permission type:

1 Edit;

2 Delete;

3 Revise;

4 Acknowledgment;

5 Distribute copy;

6 View;

7 C ancel;

PERMISSIONSTYPE X 8 Archive;

9 Print;

10 Training;

11 C reate training;

12 Save locally;

13 Sign;

14 Notification;

15 Add comment;

16 Evaluate applicability.

Return

ID # Description

SUC C ESS: 1 - Access allowed

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 374

5.2.4.3 - deleteAccessPermission

This method enables to remove the access permission to a specific document. To use it, it is necessary to
follow the standard documented below.

Java class

Request web/wwwroot/ws/java/document/DeleteAccessPermissionRequestType.java

Return web/wwwroot/ws/java/document/DeleteAccessPermissionResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

IDUSER X User ID #.

User type:

§ 1 User;

§ 2 Department;

USERTYPE X § 3 Position;

§ 4 Department/Position;

§ 5 Team;

§ 6 All.

Return

ID # Description

SUC C ESS: 1: Operation successfully performed.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 375

5.2.4.4 - deleteDocument

This method enables to delete a document. To use it, it is necessary to follow the standard documented
below.

Java class

Request web/wwwroot/ws/java/document/DeleteDocumentRequestType.java

Return web/wwwroot/ws/java/document/DeleteDocumentResponseType.java

Request

ID # Required Description

IDC ATEGORY X C ategory ID #

IDDOC UMENT X Document ID #

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

JUSTIFY X Deletion explanation

Return

ID # Description

SUC C ESS: 1: Document deleted successfully.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 376

5.2.4.5 - deleteRevision

This method enables to delete a specific revision of the document. To use it, it is necessary to follow the
standard documented below.

Java class

Request web/wwwroot/ws/java/document/DeleteRevisionRequestType.java

Return web/wwwroot/ws/java/document/DeleteRevisionResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

IDREVISION X Revision ID #.

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

JUSTIFY Revision deletion explanation.

Return

ID # Description

SUC C ESS: 1: Operation successfully performed.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 377

5.2.4.6 - downloadEletronicFile

This method enables to download an electronic file. To use it, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/document/DownloadEletronicFileRequestType.java

Return web/wwwroot/ws/java/document/DownloadEletronicFileResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #

IDREVISION Revision ID #

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

Enter 1 to download the file in pdf, if it exists; otherwise,

FGC ONVERTOPDF
downloads the original file.

IDC ATEGORY X Document category ID #

Return

ID # Description

SUC C ESS: returns an electronic file.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 378

5.2.4.7 - editDocument

This method enables to edit a document. To use it, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/document/EditDocumentRequestType.java

Return web/wwwroot/ws/java/document/EditDocumentResponseType.java

Request

ID # Required Description

IDC ATEGORY X C ategory ID #

IDDOC UMENT X Document ID #

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

IDREVISION Revision ID #

TITLE Document title

SUMMARY Document summary

Return

ID # Description

SUC C ESS: 1: Document changed successfully.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 379

5.2.4.8 - getKeyWords

This method enables to search for keywords. To use it, it is necessary to follow the standard documented
below.

Java class

Request web/wwwroot/ws/java/document/GetKeyWordsRequestType.java

Return web/wwwroot/ws/java/document/GetKeyWordsResponseType.java

Request

ID # Required Description

Matrix with the first letters of the keywords to be searched

LETTERS X for.

Note: C haracter ’*’ may be used as a wildcard.

Return

ID # Description

SUC C ESS: returns a matrix with the found keywords.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 380

5.2.4.9 - getKeyWordsData

This method enables to search for keywords. To use it, it is necessary to follow the standard documented
below.

Java class

Request web/wwwroot/ws/java/document/GetKeyWordsDataRequestType.java

Return web/wwwroot/ws/java/document/GetKeyWordsDataResponseType.java

Request

ID # Required Description

WORDS X Matrix with the keywords to be searched for.

Return

ID # Description

SUC C ESS: Returns an object matrix with the following indexes:

§ IDKEYWORD Keyword;

return § NMKEYWORD Keyword meaning;

§ SYNONYMS String matrix with the keyword synonyms.

FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 381

5.2.4.10 - listAccessPermission

This method enables to verify the access types the user has in the document. To use it, it is necessary to
follow the standard documented below.

Java class

Request web/wwwroot/ws/java/document/ListAccessPermissionRequestType.java

Return web/wwwroot/ws/java/document/ListAccessPermissionResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

IDUSER X User ID #.

Return

ID # Description

SUC C ESS: Array with the permissions:

§ 1 Edit;

§ 2 Delete;

§ 3 Revise;

§ 4 Acknowledgment;

§ 5 Distribute copy;

§ 6 View;

§ 7 C ancel;

§ 8 Archive;
return
§ 9 Print;

§ 10 Training;

§ 11 C reate training;

§ 12 Save locally;

§ 13 Sign;

§ 14 Notification;

§ 15 Add comment;

§ 16 Evaluate applicability.

FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 382

5.2.4.11 - listPendencyDocument

This method enables to list the pending documents in the draft, review, approval, or release steps of a
determined user. To use it, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/document/ListPendencyDocumentRequestType.java

Return web/wwwroot/ws/java/document/ListPendencyDocumentResponseType.java

Request

ID # Required Description

IDUSER X User ID #.

Return

ID # Description

SUC C ESS: returns the document ID #, revision, to-do task type.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 383

5.2.4.12 - newAccessPermission

This method enables to add access permission to a determined document. To use it, it is necessary to follow
the standard documented below.

Java class

Request web/wwwroot/ws/java/document/NewAccessPermissionRequestType.java

Return web/wwwroot/ws/java/document/NewAccessPermissionResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

IDUSER X User/department/position ID #.

User type:

§ 1 User;

§ 2 Department;

USERTYPE X § 3 Position;

§ 4 Department/Position;

§ 5 Team;

§ 6 All.

Permission type:

§ 1 Edit;

§ 2 Delete;

§ 3 Revise;

§ 4 Acknowledgment;

§ 5 Distribute copy;

§ 6 View;

§ 7 C ancel;
PERMISSION X § 8 Archive;

§ 9 Print;

§ 10 Training;

§ 11 C reate training;

§ 12 Save locally;

§ 13 Sign;

§ 14 Notification;

§ 15 Add comment;

Integration guide — SE Suite 2.0

 Integration via web services 384

§ 16 Evaluate applicability.

E.g.: 1,2,3

Action type:

PERMISSIONTYPE X § 1 Allow;

§ 2 Deny.

Return

ID # Description

SUC C ESS: 1: Operation successfully performed.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 385

5.2.4.13 - newDocument

This method enables to create a document. To use it, it is necessary to follow the standard documented
below.

Java class

Request web/wwwroot/ws/java/document/NewDocumentRequestType.java

Return web/wwwroot/ws/java/document/NewDocumentResponseType.java

Request

ID # Required Description

IDC ATEGORY X C ategory ID #

IDDOC UMENT Document ID #

TITLE X Document title

DSRESUME X Document summary

Document date. Date format must be Y-M-D (Year-Month-

DTDOC UMENT
Day)

Document attributes.

Example:

identifier_of_attribute1=value_of_attribute1;
identifier_of_attribute2=value_of_attribute2;
identifier_of_attribute3=value_of_attribute3.

ATTRIBUTES
Example with a multivalued attribute:

identifier_of_attribute1=value1_of_attribute1,value2_of_att
ribute1,value3_of_attribute1.

Note: For attributes with a numeric value, the decimal place

separator must be '.'. For date fields, the value must have
the “Y-M-D”(Year-Month-Day) format

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

Integration guide — SE Suite 2.0

 Integration via web services 386

Revision participants:

C ONTROL: C ontrol type

§ 1 User;

§ 2 Department;

§ 3 Position;

§ 4 Department/Position;

§ 5 Team;

PARTIC IPANTS ENTC ONTROL: ID #. E.g.: User ID # for user control.

STEP: Step. E.g.:1,2,3,4

§ 1-Draft;

§ 2-Review;

§ 3-Approval;

§ 4-Release.

SEQUENC E: Sequence. E.g.: 2,2,2,2

QTDEADLINE: Deadline (days). E.g.: 5

Starting with version 2.0, this parameter became obsolete.

FGMODEL
During the import, leave it blank.

Return

ID # Description

SUC C ESS: ID_DOC UMENT_C REATED: Document created with success.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 387

5.2.4.14 - newRevision

This method enables to create a new revision for the document. To use it, it is necessary to follow the
standard documented below.

Java class

Request web/wwwroot/ws/java/document/NewRevisionRequestType.java

Return web/wwwroot/ws/java/document/NewRevisionResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

Revision participants:

C ONTROL: C ontrol type

§ 1 User;

§ 2 Department;

§ 3 Position;

§ 4 Department/Position;

§ 5 Team;

PARTIC IPANTS ENTC ONTROL: ID #. E.g.: User ID # for user control.

STEP: Step. E.g.:1,2,3,4

§ 1-Draft;

§ 2-Review;

§ 3-Approval;

§ 4-Release.

SEQUENC E: Sequence. E.g.: 2,2,2,2

QTDEADLINE: Deadline (days). E.g.: 5

Integration guide — SE Suite 2.0

 Integration via web services 388

Matrix; Document data;

§ NMTITLE: String; Document title;

§ ATTRIBUTTES: String; Document attributes.

Example:

identifier_of_attribute1=value_of_attribute1;identifier_of_at
tribute2=value_of_attribute2;identifier_of_attribute3=value
_of_attribute3.
DOC UMENTDATA
Example with a multivalued attribute:

identifier_of_attribute1=value1_of_attribute1,value2_of_att
ribute1,value3_of_attribute1.

Note: For attributes with a numeric value, the decimal place

separator must be '.'.

Note: For date fields, the value must have the Y-M-D (Year-
Month-Day) format.

FILE: Matrix; Files;

FILE § NMFILE: String; File name;

§ BINFILE: Stream; Electronic file binary.

FGSTATUS Revision status: 0 - In progress; 1- C losed

DSJUSTIFY Revision explanation

Return

ID # Description

SUC C ESS: ID_REVISION_C REATED: Operation successfully performed.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 389

5.2.4.15 - releasePendencyDocument

This method enables to release a revision execution task of a determined user. To use it, it is necessary to
follow the standard documented below.

Java class

Request web/wwwroot/ws/java/document/ReleasePendencyDocumentRequestType.java

Return web/wwwroot/ws/java/document/ReleasePendencyDocumentResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

IDUSER X User ID #.

APPROV X Flag indicating if 1 = Approved and 2 = Rejected.

JUSTIFY Explanation text. Required when rejected.

Return

ID # Description

SUC C ESS: IDUSER Next pending user id #

USERTYPE User type

§ 1 User;

§ 2 Department;
return
§ 3 Position;

§ 4 Department/Position;

§ 5 Team;

§ 6 All.

FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 390

5.2.4.16 - searchAccessAudit

This method enables to run a search in the SE Document access audit. To use it, it is necessary to follow the
standard documented below.

Java class

Request web/wwwroot/ws/java/document/SearchAccessAuditRequestType.java

Return web/wwwroot/ws/java/document/SearchAccessAuditResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

IDUSER X User name.

Search period start date.

PERIODBEGIN X
*The format must be "Y-M-D" (Year-Month-Day)

Search period end date.

PERIODEND X
*The format must be "Y-M-D" (Year-Month-Day)

Integration guide — SE Suite 2.0

 Integration via web services 391

Return

ID # Description

SUC C ESS: returns a list with the audit data:

§ TYPEAUDIT: Audit type:

1 - View document;

2 - Registered document;

3 - Deleted document;

4 - Registered revision;

5 - Deleted revision;

6 - C losed revision;

7 - Printed controlled copy;

8 - Printed uncontrolled copy;

9 - Quantity of scheduled copies was modified;

11 - C ancelled document;

12 - Released document;

13 - Delete electronic file;

return 14 - Registered archiving;

15 - C anceled archiving;

16 - Digital signature;

17 - Add electronic file;

§ DTAC C ESS: Audit date;

§ TMAC C ESS: Audit time;

§ IDC ATEGORY: C ategory ID #;

§ IDDOC UMENT: Document ID #;

§ IDREVISION: Revision ID #;

§ IDUSER: User's name;

§ NMHOST: Host name;

§ IPADDRESS: Workstation IP;

§ NMTITLE: Document title;

§ NMDEPARTMENT: User department

FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 392

5.2.4.17 - searchCategory

This method enables to list all the categories saved in the system the authenticated user has view access to.

To use it, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/document/SearchCategoryRequestType.java

Return web/wwwroot/ws/java/document/SearchCategoryResponseType.java

Request

ID # Required Description

No parameter is required.

Return

ID # Description

SUC C ESS: Matrix with the search result:

§ C DC ATEGORY: C ategory code;

§ C DC ATEGORYOWNER: Upper level category code (0 = Root category);

return
§ IDC ATEGORY: C ategory ID #;

§ NMC ATEGORY: C ategory name;

FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 393

5.2.4.18 - searchDocument

This method enables to search for documents. To use it, it is necessary to follow the standard documented
below.

Java class

Request web/wwwroot/ws/java/document/SearchDocumentRequestType.java

Return web/wwwroot/ws/java/document/SearchDocumentResponseType.java

Request

ID # Required Description

Search filters array:

§ IDC ATEGORY: String; C ategory ID #;

§ IDDOC UMENT: String; Document ID #;

§ NMTITLE: String; Document title;

§ NMAUTHOR: String; Document author;

§ C ONTENT: String; C ontent;

§ SYNONYM: String; Search for synonym;

§ STATUS: String; Document status. Ex.: 1,2,3,4; 1: Issue;

2: Released; 3: Revision; 4: C ancelled;

§ PERMISSION: String; Document permissions. Ex.:

1,2,3,4,5; 1: Add; 2: Edit; 3: Delete; 4: Revise; 5:
Knowledge; 6: Distribute copy; 7: View; 8: C ancel; 9:
Archive; 10: Print; 11: Training; 12: C reate training; 13:
Save locally; 14: Sign; 15: Notification;
FILTERS X § IDUSERPERM: String; ID # of permission user;

§ DEPARTMENTPERM: String; Permission of department ID

#;

§ IDUSERREGISTER: String; Record of user ID #;

§ FUNC TIONPERM: String; Permission of position ID #;

§ KEYWORD: String; Keyword;

§ OPKEYWORD: Integer; Operator of key word; 1: AND; 2:

OR;

§ DTDOC LASTDAY: String; Number of days referring to the

document date (last days);

§ DTDOC BEGIN: String; Start date for document period;

§ DTDOC END: String; Deadline for document period;

§ DTREGLASTDAY: String; Number of days referring to the

document creation date (last days);

Integration guide — SE Suite 2.0

 Integration via web services 394

§ DTREGBEGIN: String; Start date for document creation

date period;

§ DTREGEND: String; Deadline for document creation date

period;

§ DTVALIDBEGIN: String; Start date for validity date

search field;

§ DTVALIDEND: String; End date for validity date search

field;

§ DTREVLASTDAY: String; Number of days referring to the

document revision date (last days);

§ DTREVBEGIN: String; Start date for document revision

period;

§ DTREVEND: String; Deadline for document revision

period;

§ IDPROJEC T: String; Project ID #;

§ NMPROJEC T: String; Project name;

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

Attributes array:

§ IDATTRIBUTE: Attribute ID#;

§ VLATTRIBUTE: Attribute value.

ATTRIBUTES Note: For attributes with a numeric value, the decimal place
separator must be '.'.

Note: For date fields, the value must have the Y-M-D (Year-
Month-Day) format.

Return

ID # Description

SUC C ESS: Matrix with search result:

§ IDDOC UMENT: String; Document ID #.

§ NMTITLE: String; Document title.

§ IDREVISION: String; ID # of the current revision of the document.

return
§ DTDOC UMENT: String; Date of the current revision of the document.

§ ADHESION: Starting with version 2.0, this parameter became obsolete. During the
import, leave it blank.

FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 395

5.2.4.19 - setAttributeValue

This method enables to assign a value to an attribute of determined document. To use it, it is necessary to
follow the standard documented below.

Java class

Request web/wwwroot/ws/java/document/SetAttributeValueRequestType.java

Return web/wwwroot/ws/java/document/SetAttributeValueResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

Revision ID #.
IDREVISION Note: If not entered, the current revision will be
considered.

IDATTRIBUTE X Attribute ID #.

VLATTRIBUTE X Attribute value.

Return

ID # Description

SUC C ESS returns '1', meaning the attribute was updated successfully.
return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 396

5.2.4.20 - uploadEletronicFile

This method enables to upload an electronic file. To use it, it is necessary to follow the standard documented
below.

Java class

Request web/wwwroot/ws/java/document/UploadEletronicFileRequestType.java

Return web/wwwroot/ws/java/document/UploadEletronicFileResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

IDREVISION Revision ID #.

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

Files array:

§ NMFILE: String; File name;

FILE X § BINFILE: Stream; Electronic file binary.

§ ERROR: Starting with version 2.0, this parameter became

obsolete. During the import, leave it blank.

Return

ID # Description

SUC C ESS: 1: Operation successfully performed.

return
FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 397

5.2.4.21 - viewDocumentData

This method enables to recover the data of a document. To use it, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/document/ViewDocumentDataRequestType.java

Return web/wwwroot/ws/java/document/ViewDocumentDataResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #.

IDREVISION Revision ID #.

Starting with version 2.0, this parameter became obsolete.

IDUSER
During the import, leave it blank.

Return

ID # Description

SUC C ESS: returns a vector with the metadata:

§ IDDOC UMENT: String; Document ID #.

§ NMTITLE: String; Document title.

§ IDC ATEGORY: String; C ategory ID #.

§ NMC ATEGORY: String; C ategory name.

§ STATUS: String; Document status; 1: Issue; 2: Released; 3: Revision; 4:

C ancelled; 5: Indexing, 6: Approval, 7: C losed contract

§ NRHITS: Integer; Hits.

return § NMAUTHOR: String; Name of document author.

§ IDREVISION: String; Revision ID #.

§ DTDOC UMENT: String; Document date.

§ QTVALIDITY: Integer; Validity.

§ FGMEASVALID: String; Validity type: 1: Days 2: Months 3: Years.

§ REVALIDATION: String; Revalidation.

§ DTVALIDITY: String; Validity date.

§ RESUME: String; Document summary.

§ C ANC ELREASON: String; C ancellation description.

Integration guide — SE Suite 2.0

 Integration via web services 398

§ URL: String; URL for the document view API.

§ ATTRIBUTTES: Matrix; Document attributes:

§ ATTRIBUTTENAME: String; Attribute ID#.

§ ATTRIBUTTEVALUE: vector; Attribute values.

FAILURE: returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 399

5.2.5 - Generic

Web Services

WSDL URL: https://<domain>/se/ws/gn_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/gn_ws.php

This section displays the generic interfaces available for SE Suite. To insert each of these items, it will be
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

addAreaToTeam Adds departments to a team

addPositionToTeam Adds positions to a team

addUserToTeam Adds new users to a team

createTeamByArea C reates a team informing the departments that will be contained in it

createTeamByPosition C reates a team informing the positions that will be contained in it

createTeamByUser C reates a team informing the users that will be contained in it

editTeamByArea Edits a team informing the departments contained in it

editTeamByPosition Edits a team informing the positions contained in it

editTeamByUser Edits a team informing the users contained in it

removeAreaFromTeam Removes departments from a team

removePositionFromTeam Removes positions from a team

removeTeam Removes a team

removeUserFromTeam Removes users from a team

Integration guide — SE Suite 2.0

 Integration via web services 400

5.2.5.1 - addAreaToTeam

This method enables to add new departments to a team.

To add new departments to the team, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\AddAreaToTeamRequestType.java

Return web\wwwroot\ws\java\generic\AddAreaToTeamResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #

ID #s of the departments that will be associated with the

DEPARTMENTS X team. Example:
(“Department1,Department2,Department3”)

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 401

5.2.5.2 - addPositionToTeam

This method enables to add new positions to a team.

To add new positions to a team, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\AddPositionToTeamRequestType.java

Return web\wwwroot\ws\java\generic\AddPositionToTeamResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #;

String separated by "," containing the position ID #s. E.g.:

POSITIONS X
("Postition1,Position2")

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 402

5.2.5.3 - addUserToTeam

This method enables to add new users to a team.

To add new users to a team, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\AddUserToTeamRequestType.java

Return web\wwwroot\ws\java\generic\AddUserToTeamResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #;

String separated by "," containing the user ID #s. E.g.:

USERS X
("User1,User2").

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 403

5.2.5.4 - createTeamByArea

This method enables to add:

§ Team with determined departments already inserted into the system;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\CreateTeamByAreaRequestType.java

Return web\wwwroot\ws\java\generic\CreateTeamByAreaResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #

NMTEAM X Team name

ID #s of the departments that will be associated with the

DEPARTMENTS X team. Example:
(“Department1,Department2,Department3”)

C ode of the components this team will be associated with.

C OMPONENT X
Example: (“107,109,73”)

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 404

5.2.5.5 - createTeamByPosition

This method enables to add:

§ Team with determined positions already inserted into the system;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\CreateTeamByPositionRequestType.java

Return web\wwwroot\ws\java\generic\CreateTeamByPositionResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #

NMTEAM X Team name

ID #s of the positions that will be associated with the team.

POSITIONS X
Example: (“Position1,Position2,Position3”)

C ode of the components this team will be associated with.

C OMPONENT X
Example: (“107,109,73”)

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 405

5.2.5.6 - createTeamByUser

This method enables to add:

§ Team with determined users already inserted into the system;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\CreateTeamByUserRequestType.java

Return web\wwwroot\ws\java\generic\CreateTeamByUserResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #

NMTEAM X Team name

ID #s of the users that will be associated with the team.

USERS X
Example: (“User1,User2,User3”)

C ode of the components this team will be associated with.

C OMPONENT X
Example: (“107,109,73”)

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 406

5.2.5.7 - editTeamByArea

This method enables to edit:

§ A team with determined departments already added to the system;

To edit each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\EditTeamByAreaRequestType.java

Return web\wwwroot\ws\java\generic\EditTeamByAreaResponseType.java

Request

ID # Required Description

IDTEAM_OLD X ID # of the team you wish to edit

New ID # of the team, if you wish to edit it. If you do not

IDTEAM_NEW X
wish to edit it, enter the same as the IDTEAM_OLD.

NMTEAM X Team name

ID #s of the departments that will be associated with the

DEPARTMENTS X team. Example:
(“Department1,Department2,Department3”)

C ode of the components this team will be associated with.

C OMPONENT X
Example: (“107,109,73”)

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 407

5.2.5.8 - editTeamByPosition

This method enables to edit:

§ Team with determined positions already inserted into the system;

To edit each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\EditTeamByPositionRequestType.java

Return web\wwwroot\ws\java\generic\EditTeamByPositionResponseType.java

Request

ID # Required Description

IDTEAM_OLD X ID # of the team you wish to edit

New ID # of the team, if you wish to edit it. If you do not

IDTEAM_NEW X
wish to edit it, enter the same as the IDTEAM_OLD.

NMTEAM X Team name

ID #s of the positions that will be associated with the team.

POSITIONS X
Example: (“Position1,Position2,Position3”)

C ode of the components this team will be associated with.

C OMPONENT X
Example: (“107,109,73”)

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 408

5.2.5.9 - editTeamByUser

This method enables to edit:

§ Team with determined users already inserted into the system;

To edit each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\EditTeamByUserRequestType.java

Return web\wwwroot\ws\java\generic\EditTeamByUserResponseType.java

Request

ID # Required Description

IDTEAM_OLD X ID # of the team you wish to edit

New ID # of the team, if you wish to edit it. If you do not

IDTEAM_NEW X
wish to edit it, enter the same as the IDTEAM_OLD

NMTEAM X Team name

ID #s of the users that will be associated with the team.

USERS X
Example: (“User1,User2,User3”)

C ode of the components this team will be associated with.

C OMPONENT X
Example: (“107,109,73”)

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 409

5.2.5.10 - removeAreaFromTeam

This method enables to remove departments from a team.

To delete each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\RemoveAreaFromTeamRequestType.java

Return web\wwwroot\ws\java\generic\RemoveAreaFromTeamResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #

ID #s of the departments that will be associated with the

DEPARTMENTS X team. Example:
(“Department1,Department2,Department3”)

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 410

5.2.5.11 - removePositionFromTeam

This method enables to remove positions from a team.

To delete each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\RemovePositionFromTeamRequestType.java

Return web\wwwroot\ws\java\generic\RemovePositionFromTeamResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #;

String separated by "," containing the position ID #s. E.g.:

POSITIONS X
("Postition1,Position2")

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 411

5.2.5.12 - removeTeam

This method enables to remove a team.

To delete each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\RemoveTeamRequestType.java

Return web\wwwroot\ws\java\generic\RemoveTeamResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 412

5.2.5.13 - removeUserFromTeam

This method enables to remove users from a team.

To delete each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\generic\RemoveUserFromTeamRequestType.java

Return web\wwwroot\ws\java\generic\RemoveUserFromTeamResponseType.java

Request

ID # Required Description

IDTEAM X Team ID #;

String separated by "," containing the user ID #s. E.g.:

USERS X
("User1,User2").

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 413

5.2.6 - Incident

Web Services

WSDL URL: https://<domain>/se/ws/in_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/in_ws.php

This section displays the web services available for SE Incident. To invoke each of these methods, it is
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

cancelIncident C ancels an incident

clearChildEntityRecord Deletes all records related to form entity descending from the incident

deleteChildEntityRecord Deletes a form entity record descending from the incident

editAttributeValue Edits the value of attributes of an incident

editChildEntityRecord Edits a record of the form entity, descending from the incident

editEntityRecord Edits an entity form from the incident

executeActivity Executes a user activity or incident decision

executeSystemActivity Executes an asynchronous system activity of incident

newAssocDocument Associates a document from SE Document to an incident activity

newAttachment Attaches a file to an incident activity

newChildEntityRecord Adds a record to the form entity descending from the incident

newIncident C reates an incident record

Integration guide — SE Suite 2.0

 Integration via web services 414

5.2.6.1 - cancelIncident

This method cancels an incident.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\CancelIncidentRequestType.java

Return web\wwwroot\ws\java\incident\CancelIncidentResponseType.java

Request structure

<cancelIncident>
<IncidentID>?</IncidentID>
<Explanation>?</Explanation>
</cancelIncident>

Request

ID # Required Description

IncidentID X Incident ID #

Explanation X Explanation

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 415

5.2.6.2 - clearChildEntityRecord

This method deletes all records related to the form entity descending from the incident

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\ClearChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\incident\ClearChildEntityRecordResponseType.java

Request structure

<clearChildEntityRecord>
<IncidentID>?</IncidentID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
</clearChildEntityRecord>

Request

ID # Required Description

IncidentID X Incident ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 416

5.2.6.3 - deleteChildEntityRecord

This method deletes a form entity record descending from the incident.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\DeleteChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\incident\DeleteChildEntityRecordResponseType.java

Request structure

<deleteChildEntityRecord>
<IncidentID>?</IncidentID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
</deleteChildEntityRecord>

Request

ID # Required Description

IncidentID X Incident ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

C hildRecordOID X Record code related to descending form entity

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 417

5.2.6.4 - editAttributeValue

This method edits the value of the attributes of an incident.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\EditAttributeValueRequestType.java

Return web\wwwroot\ws\java\incident\EditAttributeValueResponseType.java

Request structure

<editAttributeValue>
<IncidentID>?</IncidentID>
<AttributeList>
<!--1 or more repetitions:-->
<Attribute>
<AttributeID>?</AttributeID>
<!--Zero or more repetitions:-->
<AttributeValueList>
<AttributeValue>?</AttributeValue>
</AttributeValueList>
</Attribute>
</AttributeList>
</editAttributeValue>

Request

ID # Required Description

IncidentID X Incident ID #

AttributeID X Attribute ID #

Attribute value

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand

AttributeValue separators and with period (.) as decimal separator

§ Currency: numeric digits without the thousand

separators and with period (.) as decimal separator

Integration guide — SE Suite 2.0

 Integration via web services 418

§ Date: YYYY-MM-DD

§ Hour: HHHH:MM

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 419

5.2.6.5 - editChildEntityRecord

This method edits a record of the form entity, descending from the incident.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\EditChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\incident\EditChildEntityRecordResponseType.java

Request structure

<editChildEntityRecord>
<IncidentID>?</IncidentID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editChildEntityRecord>

Integration guide — SE Suite 2.0

 Integration via web services 420

Request

ID # Required Description

IncidentID X Incident ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

C hildRecordOID X Record code related to descending form entity

EntityAttributeID Form entity attribute ID #

Form entity attribute value.

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

EntityAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

RelationshipAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 421

5.2.6.6 - editEntityRecord

This method edits an entity form from the incident

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\EditEntityRecordRequestType.java

Return web\wwwroot\ws\java\incident\EditEntityRecordResponseType.java

Request structure

<editEntityRecord>
<IncidentID>?</IncidentID>
<EntityID>?</EntityID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editEntityRecord>

Integration guide — SE Suite 2.0

 Integration via web services 422

Request

ID # Required Description

IncidentID X Incident ID #

EntityID X Form entity ID #

EntityAttributeID Form entity attribute ID #

Form entity attribute value.

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

EntityAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

RelationshipAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 423

5.2.6.7 - executeActivity

This method executes a user activity or incident decision.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\ExecuteActivityRequestType.java

Return web\wwwroot\ws\java\incident\ExecuteActivityResponseType.java

Request structure

<executeActivity>
<IncidentID>?</IncidentID>
<ActivityID>?</ActivityID>
<ActionSequence>?</ActionSequence>
<UserID>?</UserID>
</executeActivity>

Request

ID # Required Description

IncidentID X Incident ID #

ActivityID X Activity ID #

ActionSequence X Number of action sequence

UserID User ID

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 424

5.2.6.8 - executeSystemActivity

This method executes an incident asynchronous system activity.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\ExecuteSystemActivityRequestType.java

Return web\wwwroot\ws\java\incident\ExecuteSystemActivityResponseType.java

Request structure

<executeSystemActivity>
<IncidentID>?</IncidentID>
<ActivityID>?</ActivityID>
</executeSystemActivity>

Request

ID # Required Description

IncidentID X Incident ID #

ActivityID X Activity ID #

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 425

5.2.6.9 - newAssocDocument

This method associates a document from SE Document with an incident activity.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\NewAssocDocumentRequestType.java

Return web\wwwroot\ws\java\incident\NewAssocDocumentResponseType.java

Request structure

<newAssocDocument>
<IncidentID>?</IncidentID>
<ActivityID>?</ActivityID>
<DocumentID>?</DocumentID>
</newAssocDocument>

Request

ID # Required Description

IncidentID X Incident ID #

ActivityID X Activity ID #

DocumentID X Document ID #

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 426

5.2.6.10 - newAttachment

This method attaches a file to an incident activity.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\NewAttachmentRequestType.java

Return web\wwwroot\ws\java\incident\NewAttachmentResponseType.java

Request structure

<newAttachment>
<IncidentID>?</IncidentID>
<ActivityID>?</ActivityID>
<FileName>?</FileName>
<FileContent>?</FileContent>
<UserID>?</UserID>
<AttachmentID>?</AttachmentID>
<AttachmentName>?</AttachmentName>
<Summary>?</Summary>
</newAttachment>

Request

ID # Required Description

IncidentID X Incident ID #

ActivityID X Activity ID #

FileName X File name (including its extension)

FileC ontent X Binary content of the file

UserID User ID

AttachmentID Attachment ID #

AttachmentName Attachment name

Summary Summary

Integration guide — SE Suite 2.0

 Integration via web services 427

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

RecordID ID # of the record added by the method

Integration guide — SE Suite 2.0

 Integration via web services 428

5.2.6.11 - newChildEntityRecord

This method adds a record to the form entity descending from the incident.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\NewChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\incident\NewChildEntityRecordResponseType.java

Request structure

<newChildEntityRecord>
<IncidentID>?</IncidentID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</newChildEntityRecord>

Integration guide — SE Suite 2.0

 Integration via web services 429

Request

ID # Required Description

IncidentID X Incident ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

EntityAttributeID Form entity attribute ID #

Form entity attribute value.

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

EntityAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

RelationshipAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

Integration guide — SE Suite 2.0

 Integration via web services 430

5.2.6.12 - newIncident

This method creates an incident record.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\incident\NewIncidentRequestType.java

Return web\wwwroot\ws\java\incident\NewIncidentResponseType.java

Request structure

<newIncident>
<IncidentTypeID>?</IncidentTypeID>
<IncidentTitle>?</IncidentTitle>
<UserID>?</UserID>
</newIncident>

Request

ID # Required Description

IncidentTypeID X Incident type ID #

IncidentTitle X Incident title

UserID User ID

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

RecordID ID # of the record added by the method

Integration guide — SE Suite 2.0

 Integration via web services 431

5.2.7 - Inspection

Web Services

WSDL URL: https://<domain>/se/ws/ip_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/ip_ws.php

This section displays the interfaces available for SE Inspection. To insert each of these items, it will be
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

createUpdateConfiguration Inserts, edits, or deletes inspection form data

createUpdateDeleteQualityIndex C reates, edits, or deletes a quality index

createUpdateDeleteReceiving C reates, edits, or deletes a receiving

editQualificationIndexValue Edits the value of a qualification index

relateCharacteristicToInspConfig
C haracteristic relationship in inspection configuration
uration

relateChecklistToInspConfigurati
C hecklist relationship in inspection configuration
on

Integration guide — SE Suite 2.0

 Integration via web services 432

5.2.7.1 - createUpdateConfiguration

This import template enables to insert, edit, and delete:

§ Inspection form data.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\inspection\CreateUpdateConfigurationRequestType.jav
Request
a

web\wwwroot\ws\java\inspection\CreateUpdateConfigurationResponseType.ja
Return
va

Request

ID # Required Description

C ode of the operation to be performed:

14 – Insert;
FGOPTION X
15 – Edit;

16 – Insert/Edit.

IDGENTYPE X1 Inspection form type ID #

IDC ONFIGURATION X Inspection form ID #

IDOBJEC T X1 Item/Supply ID #

IDREVISION X1 Item/Supply revision ID #

IDPROC ESS X1 Process ID #

IDPROC REVISION X1 Process revision ID #

IDAC TIVITY X1 Process activity ID #

NMEVALC ONFGRUP X2 Evaluation group name

IDQUALITYINDEX X2 Quality index ID #

Allow editing the receiving flow:

FGALLOWEDITWF 1 – Allow;

2 – Do not allow (default option);

IDWORKFLOW X3 Inspection flow ID #

FGBLOC K Block receiving for this inspection form:

Integration guide — SE Suite 2.0

 Integration via web services 433

1 – Block

2 – Do not block (default option);

Frequency type:

1 – Uncontrolled;
FGTYPEFREQUENC E X4 2 – Execution date;

3 – Inspect an instance every... (only available when there

are processes involved)

QTFREQUENC E X5 Frequency/Number of instances

Frequency unit:

1 – Days;

FGFREQUENC E X5 2 – Weeks;

3 – Months;

4 – Years

DTNEXTEXEC UTION X5 Next execution date

IDTEAM X5 Responsible team

Inspection frequency:

1 - Skip-lot
FGINSPFREQ X6
2 - Total inspection

3 - No inspection

NMSKIPTYPE X6 Skip-lot type name

NRSEQ X6 Frequency sequence of the selected skip-lot

C ontrol initial sample:

FGINITIALSMP 1 – Yes;

2 – No (default option)

Sample status:

1 – Blocked;
FGSTATUSINITIALSMP X7
2 – Initial sample;

3 – Released

DTDUEDATE X7 Deadline

C ontrol initial sampling validity:

FGVALIDITYRIA 1 – Yes;

2 – No (default option)

QTVALIDITYRIA X8 Initial sampling validity frequency

FGFREQVALIDITYRIA X8 Initial sampling validity frequency unit

Integration guide — SE Suite 2.0

 Integration via web services 434

1 – Days;

2 – Weeks;

3 – Months;

4 – Inspections

DSINITIALSMP Initial sampling comments

Register averages/readings:
2
FGAVGREADING X 1 – Register averages;

2 – Register readings

Rule:

1 – Sampling plan;

FGSAMPLEPLAN X9 2 – Sampling table;

3 – Defined size;

4 – Percentage

Sampling plan:

1 – Simple;
FGDEFAULSAMPLEPLAN X9
2 – Double;

3 – Multiple

Inspection level:
IDLEVEL X9
[01, 02, 03, S1, S2, S3, S4]

Work regime:

1 – Reduced;
FGSWITC HRULE X9
2 – Normal;

3 – Tightened

NQA:

[0.010, 0.015, 0.025, 0.04, 0.65, 0.1, 0.15, 0.25, 0.4, 0.65,
VLAQL X9
1, 1.5, 2.5, 4, 6.5, 10, 15, 25, 40, 65, 100, 150, 250, 400,
650, 1000]

IDTABLE X9 Sampling table ID #

VLSAMPLESIZE X9 Sample size

Fixed sample size:

FGFIXED X9 1 – Yes;

2 – No (default option);

VLAC C EPTABLE X9 Maximum number/percentage of rejects

VLPERC ENTAGE X9 Percentage

Integration guide — SE Suite 2.0

 Integration via web services 435

§ X 1 – Required when adding; ignored for other actions.

§ X 2 – Mandatory when adding, optional while editing and deleting.

§ X 3 – Required if it does not allow editing the inspection flow.

§ X 4 – Required when adding if the form object type allows the frequency to be controlled.

§ X 5 – Required when adding if the frequency is controlled.

§ X 6 – Required when adding if the form object type requires the inspection frequency to be entered.

§ X 7 – Required when adding if the form object type requires the inspection frequency to be entered and the option to
control the initial sample is active.

§ X 8 – Required when adding if the form object type requires the inspection frequency to be entered and the option to
control the initial sample and the validity are active.

§ X 9 – Required if the form object type requires filling out a sampling plan and the option of the sampling rule requires it
to be filled in.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 436

5.2.7.2 - createUpdateDeleteQualityIndex

This import template enables to insert, edit, and delete:

§ Index evaluation.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\inspection\CreateUpdateDeleteQualityIndexRequestTyp
Request
e.java

web\wwwroot\ws\java\inspection\CreateUpdateDeleteQualityIndexResponseTy
Return
pe.java

Request

ID # Required Description

Action option:

11 – Add
FGOPTION X 12 – Edit

13 – Delete, only the last evaluation of an index may be

deleted

IDINDEX X Index ID #

DTINDEXEVALVALID X1 Due date.

VLINDEXEVAL X2 Score value.

IDOBJEC T X2 Object ID # (Item/Supply).

IDC OMMERC IAL X2 Supplier company ID.

DSINDEXEVAL Evaluation description.

IDPROC ESS X2 Process ID #

IDAC TIVITY X2 Activity ID #.

§ X 1 – Required when adding and editing; ignored while deleting.

§ X 2 – Required for inspections where Object, Process, Process activity, or Supplier is part of the evaluation; otherwise,
they will be ignored.

Integration guide — SE Suite 2.0

 Integration via web services 437

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 438

5.2.7.3 - createUpdateDeleteReceiving

This method enables to insert, edit, delete:

§ Data of a receiving.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\inspection\CreateUpdateDeleteReceivingRequestType.j
Request
ava

web\wwwroot\ws\java\inspection\CreateUpdateDeleteReceivingResponseType.
Return
java

Request

ID # Required Description

Action option:

3 – Add;
FGOPTION X
4 – Edit;

5 – Delete.

IDC ONFIGURATION X1 Inspection form ID #

IDC OMMERC IAL X2 Supplier company ID.

IDLOT X3 Lot number

IDINVOIC E X3 Invoice number

DTINVOIC E X3 Invoice date

IDORDER X3 Order number

DTORDER X3 Order date

IDSO X3 Request order number

DTSO X3 Request order date

IDPO X3 Production order number

DTPO X3 Production order date

DTREC VEST X3 Estimated date

QTREC VTIMEEST X³ Estimated time

Integration guide — SE Suite 2.0

 Integration via web services 439

DTREC VAC T X3 Actual date

QTREC VTIMEAC T X³ Actual time

VLQTYEST X3 Expected amount

VLQTYAC T X3 Actual quantity

VLC OSTEST X3 Estimated cost

VLC OSTAC T X3 Actual cost

IDWORKFLOW X4 Inspection flow ID #

DSREC EIVING X³ C omments

Send to the next step (only for editing):

FGEXEC UTE 1 – Send to the next step;

2 – Do not send to the next step.

IDWFPROC ESS X5 Workflow instance ID #

IDREC EIVING X6 Receiving ID # (number)

§ X 1 – Required when adding; ignored for other actions.

§ X 2 – Required for inspections of Supplies, Services, and External finished products; ignored for other object types.

§ X 3 – Required, not required, or ignored, depending on the configurations set in the inspection form type.

§ X 4 – Required if the "Allow editing flow during receiving" option is checked in the inspection form, or ignored otherwise.

§ X 5 – Required if the inspection object is a Workflow process instance; ignored otherwise.

§ X 6 – Required for the change and deletion.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 440

5.2.7.4 - editQualificationIndexValue

This import template enables to edit the qualification index and send it to the next step:

§ Receiving data.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\inspection\EditQualificationIndexValueRequestType.j
Request
ava

web\wwwroot\ws\java\inspection\EditQualificationIndexValueResponseType.
Return
java

Request

ID # Required Description

IDREC EIVING X Rcv #.

NMDLVQUALINDEX X Index name

NMDLVQUALOPTION X Option for index qualification

Execute the step:

FGEXEC UTE
1 – Send to the next step;

DSDVLQUALINDEX Qualification index comments

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 441

5.2.7.5 - relateCharacteristicToInspConfiguration

This import template enables to associate, edit, and disassociate:

§ Inspection form characteristic data.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\inspection\RelateCharacteristicToInspConfigurationR
Request
equestType.java

web\wwwroot\ws\java\inspection\RelateCharacteristicToInspConfigurationR
Return
esponseType.java

Request

ID # Required Description

C ode of the operation to be performed:

20 – Associate;
FGOPTION X
21 – Edit;

22 – Disassociate.

IDC ONFIGURATION X Inspection form ID #

IDC HARAC TERISTIC X C haracteristic ID #

Required:

FGREQUIRED 1 – Required (default option);

2 – Not required

NRVALIDITY X1 Validity

Frequency unit:

1 – Days;

FGVALIDITY X1 2 – Weeks;

3 – Months;

4 – Inspections

Add characteristic to the inspection report

FGENABLEDPRINT 1 – Yes;

2 – No (default option)

FGAVGREADING X2 Register averages/readings:

Integration guide — SE Suite 2.0

 Integration via web services 442

1 – Register averages;

2 – Register readings

Rule:

1 – Sampling plan;

FGTYPESAMPLEPLAN X3 2 – Sampling table;

3 – Defined size;

4 – Percentage

Sampling plan:

1 – Simple;
FGSAMPLEPLAN X3
2 – Double;

3 – Multiple

Inspection level:
IDLEVEL X3
[01, 02, 03, S1, S2, S3, S4]

Work regime:

1 – Reduced;
FGSWITC HRULE X3
2 – Normal;

3 – Tightened

NQA:

[0.010, 0.015, 0.025, 0.04, 0.65, 0.1, 0.15, 0.25, 0.4, 0.65,
VLAQL X3
1, 1.5, 2.5, 4, 6.5, 10, 15, 25, 40, 65, 100, 150, 250, 400,
650, 1000]

IDTABLE X3 Sampling table ID #

VLSAMPLESIZE X3 Sample size

Fixed sample size:

FGFIXED X3 1 – Yes;

2 – No (default option);

VLAC C EPTABLE X3 Maximum number/percentage of rejects

VLPERC ENTAGE X3 Percentage

§ X¹ – Required when adding if option "Required" is disabled

§ X² – Required when adding, optional while editing/deleting

§ X³ – Required if the selected sampling type option requires filling the field in.

Integration guide — SE Suite 2.0

 Integration via web services 443

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 444

5.2.7.6 - relateChecklistToInspConfiguration

This method enables to associate:

§ Checklist with the inspection configuration.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\inspection\RelateChecklistToInspConfigurationReques
Request
tType.java

web\wwwroot\ws\java\inspection\RelateChecklistToInspConfigurationRespon
Return
seType.java

Request

ID # Required Description

C ode of the operation to be performed:

FGOPTION X 25 – Associate;

26 – Disassociate.

IDC ONFIGURATION X Inspection form ID #.

IDC HEC KLIST X C haracteristic ID #.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 445

5.2.8 - Maintenance

Web Services

WSDL URL: https://<domain>/se/ws/mn_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/mn_ws.php

This section displays the interfaces available for SE Maintenance. To insert each of these items, it will be
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

insertMeterReading Allows inserting asset meter readings.

insertVariableReading Allows inserting asset variable readings.

createCorrectiveMaintenance C reates a corrective maintenance.

Integration guide — SE Suite 2.0

 Integration via web services 446

5.2.8.1 - insertMeterReading

This method enables to insert:

§ Asset meter readings.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request InsertMeterReadingRequestType.java

Return InsertMeterReadingResponseType.java

Request

ID # Required Description

idobject X Asset ID #.

Action. List of options:

fgaction X 1 – New meter reading

2 – New meter restart

Reading value.
vlreadvalue X¹ Use point as decimal separator and do not used thousands
separator, for example “16000.000”.

Meter reading date, in the format mm/dd/YYYY.

dtreaddate If empty, it will consider the date and time of the import
service.

Meter reading time, in the format hh:mm (00:00 - 23:59).

qthrread X² If empty, it will consider the date and time of the import
service.

X¹ - Required if the action is New meter reading. Not required if the action is New meter restart.

X¹ - Required if the reading date is filled in.

Return

ID # Description

SUC C ESS: 1.
return
Failure: message describing the error.

Integration guide — SE Suite 2.0

 Integration via web services 447

5.2.8.2 - insertVariableReading

This method enables to insert:

§ Readings of asset variables.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request InsertVariableReadingRequestType.java

Return InsertVariableReadingResponseType.java

Request

ID # Required Description

idobject X Asset ID #.

idvariable X Variable ID #.

If it is a subjective variable:

Name of the option of the list of values of the variable.

vlreadvalue X If it is an objective variable:

Reading value.

Use point as decimal separator and do not used thousands

separator, for example “16000.000”.

Variable reading date, in the format mm/dd/YYYY.

dtreaddate If empty, it will consider the date and time of the import
service.

Variable reading time, in the format hh:mm (00:00 -

qthrread X¹ 23:59). If empty, it will consider the date and time of the
import service.

X¹ - Required if the reading date is filled in.

Return

ID # Description

SUC C ESS: 1.
return
Failure: message describing the error.

Integration guide — SE Suite 2.0

 Integration via web services 448

5.2.8.3 - createCorrectiveMaintenance

This method enables to insert:

§ Data of a corrective maintenance.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\maintenance\CreateCorrectiveMaintenanceRequestType.
Request
java

web\wwwroot\ws\java\maintenance\CreateCorrectiveMaintenanceResponseType
Return
.java

Request

ID # Required Description

IDAC TIVITY Activity ID # (Generated automatically if not entered).

IDMODELAC TIVITY X Standard activity ID #

IDASSET X Asset ID #

DTSTART X¹ Execution start date in format “Y-M-D” (Year-Month-Day)

TMSTART X¹ Execution start time

VLPERC ENTAGE X¹ Actual percentage (%).

IDSERVIC EC ENTER X² Service center ID #

Responsible technician:

TEC RESP X² § Internal service center: User ID

§ Third-party service center: Name

Document attributes.

Example:

§ identifier_of_attribute1=valued_of_attribute1;

§ identifier_of_attribute2=value_of_attribute2;

§ identifier_of_attribute3=value_of_attribute3;
ATTRIBUTES X³
Example with a multivalued attribute:

§ identifier_of_attribute1=value1_of_attribute1,value2_of_
attribute1,value3_of_attribute1.

Note: For attributes with a numeric value, the decimal place

separator must be '.'. For date fields, the value must have
the “Y-M-D”(Year-Month-Day) format

Integration guide — SE Suite 2.0

 Integration via web services 449

X¹ - Required if the "Start date" and/or "Start time" and/or "Actual percentage" field(s) is(are) filled in

X² - Required if it is not entered in the standard activity

X³ - Required if the standard activity has a required attribute.

Return

ID # Description

SUC C ESS: 1.
return
FAILUREReturns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 450

5.2.9 - PDM

Web Services

WSDL URL: https://<domain>/se/ws/it_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/it_ws.php

This section displays the interfaces available for SE PDM. To insert each of these items, it will be necessary to
follow the standard documented in the upcoming sections.

Available web services

Method Description

addBom C reates a structure item

addCharacteristicAttrib Import of attribute type characteristics

addCharacteristicVar Import of variable type characteristics

addCustomer C reates or edits a customer associated with an item

addManufacturer Inserts or edits a manufacturer associated with an item

addSupplier Inserts or edits a supplier associated with an item

deleteBom Deletes an item structure

deleteCustomer C reates or edits a customer associated with an item

deleteItem Deletes an item

deleteManufacturer Removes a manufacturer associated with an item

deleteSupplier Deletes a supplier associated with an item

import_attrib_assoc Item attribute value import

newItem C reates or edits an item

newItemType C reates a new item type

relateAssetTypeToCharacteristic Import of the asset type association with the item characteristics

Integration guide — SE Suite 2.0

 Integration via web services 451

5.2.9.1 - addBom

This method enables to create:

§ Data of a structure item.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\AddBomRequestType.java

Return web\wwwroot\ws\java\item\AddBomResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

NMOBJEC T X Object name

IDOBJEC TOWNER X ID # (Upper level object)

IDREVISIONOWNER X Revision (Upper level object)

VLQUANTITY X Quantity

Object specification (C onsidered 1 by default).

FGAPPLIC ATION 1 - Item;

2 - Supply.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 452

5.2.9.2 - addCharacteristicAttrib

This method enables:

§ To add an attribute type characteristic

§ To edit an attribute type characteristic

§ To add or, if existent, edit an attribute type characteristic

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\AddCharacteristicAttribRequestType.java

Return web\wwwroot\ws\java\item\AddCharacteristicAttribResponseType.java

Request

ID # Required Description

IDOBJEC T X Item ID #.

IDREVISION X Item revision ID #.

IDC HAREC TERISTIC X C haracteristic ID #.

NMC HARAC TERISTIC X C haracteristic name.

IDINPUTC HARAC TYPE C haracteristic type ID #.

Special characteristic:

DSC HARAC SPEC IAL 1 – Yes;

2 – No.

NMC LIENTSYMBOL X1 C ustomer symbol name

NMSUPPLIERSYMBOL X1 Supplier symbol name

DSOBSERVATION C omments.

DSSPEC IFIC ATION Specifications.

X 1 - Required if feature is special.

Integration guide — SE Suite 2.0

 Integration via web services 453

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 454

5.2.9.3 - addCharacteristicVar

This method enables:

§ To add a variable type characteristic.

§ To edit a variable type characteristic.

§ To add or, if existent, edit a variable type characteristic

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\AddCharacteristicVarRequestType.java

Return web\wwwroot\ws\java\item\AddCharacteristicVarResponseType.java

Request

ID # Required Description

IDOBJEC T X Item ID #

IDREVISION X Item revision ID #

IDC HARAC TERISTIC X C haracteristic ID #

NMC HARAC TERISTIC X C haracteristic name

IDINPUTC HARAC TYPE C haracteristic type ID #

Special characteristic:

DSC HARAC SPEC IAL 1 - Yes;

2 - No;

NMC LIENTSYMBOL X1 C ustomer symbol name

NMSUPPLIERSYMBOL X1 Supplier symbol name

QTDEC IMAL X Number of decimal places

Limits:

0 - Bilateral;
FGLIMIT X
1 - Unilateral up;

2 - Unilateral down;

IDMEASUNITY X Measurement unit ID #

VLNOMINAL X Nominal value

VLUPPER X2 Upper tolerance

Integration guide — SE Suite 2.0

 Integration via web services 455

VLLOWER X3 Lower tolerance

DSOBSERVATION C omments

X1 Required if the characteristic is special.

X2 Required only when the limit is bilateral or unilateral up.

X3 Required only when the limit is bilateral or unilateral down.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 456

5.2.9.4 - addCustomer

This method enables to create or edit:

§ Data of a customer associated with an item.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\AddCustomerRequestType.java

Return web\wwwroot\ws\java\item\AddCustomerResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

IDC OMMERC IAL X1 C ompany ID

NMC OMPANY X1 C ompany name

IDC OMPANY X2 C ompany code

IDITEMNUMBC UST C ustomer item #

IDREVC USTOMER C ustomer revision #

IDDRAWC USTOMER C ustomer drawing #

DTDRAWENGC HANGES C ustomer drawing changed on date

X 1 - Required if the “C ompany code” is not filled in.

X 2 - Required if the “C ompany ID” and/or the “C ompany name” are not filled in.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 457

5.2.9.5 - addManufacturer

This method enables to associate a manufacturer with the item. To insert each of these items, it is necessary
to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\AddManufacturerRequestType.java

Return web\wwwroot\ws\java\item\AddManufacturerResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

IDC OMMERC IAL X1 Name of the object type

NMC OMPANY X1 C ompany name

IDC OMPANY X2 C ompany code

IDREFERENC E X Material reference in the manufacturer

NMMODEL X Material name in the manufacturer

X 1 - Required if the “C ompany code” is not filled in.

X 2 - Required if the “C ompany ID” and/or the “C ompany name” are not filled in.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 458

5.2.9.6 - addSupplier

This method enables to associate and edit the supplier of the item.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\AddSupplierRequestType.java

Return web\wwwroot\ws\java\item\AddSupplierResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

IDC OMMERC IAL X1 Name of the object type

NMC OMPANY X1 C ompany name

IDC OMPANY X2 C ompany code

DSINPUTSUPP X Description of the supplier supply

IDINPUTSUPP X Supplier supply ID #

VLQTMINREPLAC Minimum reorder quantity

QTEXPEC TARRIVED Supply expected delivery

Expected delivery measurement:

1 - Day

FGEXPEC TARRIVED 2 - Week

3 - Month

4 - Year

VLC OST C ost

X 1 - Required if the “C ompany code” is not filled in.

X 2 - Required if the “C ompany ID” and/or the “C ompany name” are not filled in.

Return

ID # Description

return SUC C ESS: 1

Integration guide — SE Suite 2.0

 Integration via web services 459

FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 460

5.2.9.7 - deleteBom

This method enables to delete:

§ Data of a structure of an item.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\AddBomRequestType.java

Return web\wwwroot\ws\java\item\AddBomResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

IDREVISION X Object revision

IDOBJEC TOWNER X ID # (Upper level object)

IDREVISIONOWNER X Revision (Upper level object)

Object specification (C onsidered as 1 by default):

FGAPPLIC ATION 1 - Asset;

2 - Supply.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 461

5.2.9.8 - deleteCustomer

This method enables to delete:

§ Data of a customer associated with an item.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\DeleteCustomerRequestType.java

Return web\wwwroot\ws\java\item\DeleteCustomerResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

IDC OMMERC IAL X1 C ompany ID

NMC OMPANY X1 C ompany name

IDC OMPANY X2 C ompany code

X 1 - Required if the “C ompany code” is not filled in.

X 2 - Required if the “C ompany ID” and/or the “C ompany name” are not filled in.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 462

5.2.9.9 - deleteItem

This method enables to delete:

§ Data of an item:

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\DeleteItemRequestType.java

Return web\wwwroot\ws\java\item\DeleteItemResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 463

5.2.9.10 - deleteManufacturer

This method enables to disassociate a manufacturer from the item.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\DeleteManufacturerRequestType.java

Return web\wwwroot\ws\java\item\DeleteManufacturerResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #.

IDC OMMERC IAL X1 Name of the object type.

NMC OMPANY X1 C ompany name.

IDC OMPANY X2 C ompany code.

X 1 - Required if the “C ompany code” is not filled in.

X 2 - Required if the “C ompany ID” and/or the “C ompany name” are not filled in.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 464

5.2.9.11 - deleteSupplier

This method enables to disassociate the supplier from the item.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\DeleteSupplierRequestType.java

Return web\wwwroot\ws\java\item\DeleteSupplierResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

IDC OMMERC IAL X1 Name of the object type

NMC OMPANY X1 C ompany name

IDC OMPANY X2 C ompany code

X 1 - Required if the “C ompany code” is not filled in.

X 2 - Required if the “C ompany ID” and/or the “C ompany name” are not filled in.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 465

5.2.9.12 - import_attrib_assoc

This method enables the association of an item with an attribute.

For a successful association of attributes, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\Import_attrib_assocRequestType.java

Return web\wwwroot\ws\java\item\Import_attrib_assocResponseType.java

Request

ID # Required Description

IDOBJEC T X Item ID #

NMLABEL X Attribute label

Attribute value.

According to FGDATATYPE:

VALUE X 1 - NMATTRIBUTE

2 - VLATTRIBUTE

3 - DTATTRIBUTE

IDREVISION Revision ID #

NMATTRIBUTE Memo

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 466

5.2.9.13 - newItem

This method enables to create or edit:

§ Data of an item:

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\NewItemRequestType.java

Return web\wwwroot\ws\java\item\NewItemResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

NMOBJEC T X Object name

IDOBJEC TTYPE X Object type ID #

IDTEAM X Responsible team ID #.

IDMEASUNITY X Measurement unit

Physical state:

1 Solid;

FGPHYSIC ALSTATE Liquid;

3 Gas;

4 Sludge

IDODOR Odor ID #

IDC OLOR C olor name

IDONUC ODE UN code

IDDANGEROUSNESS Hazard ID #

IDC LASSIFIC ATION C lassification ID #

IDABNTC ODE ABNT code

DSC ONSTITUENTS General description of composition

Integration guide — SE Suite 2.0

 Integration via web services 467

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 468

5.2.9.14 - newItemType

This method enables to create/edit:

§ Data of an item type.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\item\NewItemTypeRequestType.java

Return web\wwwroot\ws\java\item\NewItemTypeResponseType.java

Request

ID # Required Description

IDOBJEC TTYPE X Item type ID #.

NMOBJEC TTYPE X Item type name.

IDOBJEC TTYPEOWNER Upper level item type ID #.

Use identification mask:

FGUSEMASK X 1 - Yes;

2 - No.

Identification mask ID #. (required if the option to use

IDMASK
identification mask is equal to 1).

Allow editing the identifier generated by the identification

mask (required if the option to use identification mask is

FGEDITID equal to 1):

1 - Yes;

2 - No.

Revision control:

FGUSEREVISION X 1 - Yes;

2 - No.

Revision ID #:

1 - Numeric;
FGREVID X1
2 - Text;

3 - C ustomized.

Approval type:
FGREVAPPROVALMODE X1

Integration guide — SE Suite 2.0

 Integration via web services 469

1 - Incremental;

2 - C ircular.

C losure type:

FGREVRELEASEMODE X1 1 - Automatic;

2 - Manual.

QTREVRETENTION X1 Number of retentions of obsolete revisions.

Retention frequency:

1 - Revisions;
FGREVRETENTIONMODE X1
2 - Months;

3 - Years.

Route type:

FGREVROUTETYPE X1 1 - Fixed;

2 - Variable.

Acceptance of draft revision:

FGREVELABC LAUSE X1 1 - AND;

2 - OR.

Acceptance of review revision:

FGREVC ONSC LAUSE X1 1 - AND;

2 - OR.

Acceptance of approval revision:

FGREVAPROVC LAUSE X1 1 - AND;

2 - OR.

Acceptance of release revision:

FGREVHOMOLOGC LAUSE X1 1 - AND;

2 - OR.

Watermark:

FGDOC VIEWWATERMARK X 1 - Yes;

2 - No.

Publish PDF files:

FGC ONVERTTOPDF X 1 - Yes;

2 - No.

File type:

1 - Simple;
FGFILETYPE X
2 - Multiple;

3 - C omplex.

Integration guide — SE Suite 2.0

 Integration via web services 470

C omplex file container ID #

IDC OMPLEXFILEC ONT (required if the file type option

is equal to 3).

X 1 - Required if the option to control the revision is equal to 1

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 471

5.2.9.15 - relateAssetTypeToCharacteristic

This method enables to associate the asset type with a characteristic.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

web\wwwroot\ws\java\item\RelateAssetTypeToCharacteristicRequestType.jav
Request
a

web\wwwroot\ws\java\item\RelateAssetTypeToCharacteristicResponseType.ja
Return
va

Request

ID # Required Description

IDOBJEC T X Item ID #

IDREVISION X Item revision ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDASSETTYPE X Asset type ID #.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 472

5.2.10 - Performance

Web Services

WSDL URL: https://<domínio>/se/ws/st_ws.php?wsdl

Web Service URL: https://<domínio>/softexpert/webserviceproxy/se/ws/st_ws.php

This section displays the interfaces available for SE Performance. To insert each of these items, it will be
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

C reates target/measurement/accumulated target/accumulated

addMeasuresInAdinterface
measurement value for a period of the indicator

Integration guide — SE Suite 2.0

 Integration via web services 473

5.2.10.1 - addMeasuresInAdinterface

This method makes it possible to create a target/measurement/accumulated target/cumulative value for a

period of the indicator. To add, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/strategy/AddMeasuresInAdinterfaceRequestType.java

Return web/wwwroot/ws/java/strategy/AddMeasuresInAdinterfaceResponseType.java

Request

ID # Required Description

idscmetric X Scorecard indicator ID #.

User ID # with permission to import the values into the

iduser X
indicators.

ID # of the period for daily, weekly, and bi-weekly

nrsubperiod indicators. See in the SE Performance help the values and
rules of the indicator frequency.

ID # of validity PERIOD of the values. See in the SE

nrperiod X Performance help the values and rules of the indicator
frequency.

ID # of the validity YEAR of the values. See in the SE

nryear X Performance help the values and rules of the indicator
frequency.

vlweight Weight. The default value is 1.

ID # for periods with non-applied values; enter value 1 for

fgnotapply
cases of non-applied periods.

vltarget Target value

vlactual Measurement value

vltargetaccum Accumulated target value

vlactualaccum Accumulated measurement value

Return

ID # Description

return SUC C ESS: Saved successfully.

Integration guide — SE Suite 2.0

 Integration via web services 474

FAILURE: Returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 475

5.2.11 - Physical file

Web Services

WSDL URL: http://<domínio>/se/ws/arch_ws.php?wsdl

Web Service URL: http://<domínio>/se/ws/arch_ws.php

In this section, the interfaces available for the SE Archive are displayed. To insert each of these items, it will be
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

newPhysicalFileLoan Inserts a physical file loan record

Integration guide — SE Suite 2.0

 Integration via web services 476

5.2.11.1 - newPhysicalFileLoan

This method enables to add a record of a physical file loan. For this action, it is necessary to follow the
standard documented below.

Java class

Request web/wwwroot/ws/java/archival/NewPhysicalFileLoanRequestType.java

Return web/wwwroot/ws/java/archival/NewPhysicalFileLoanResponseType.java

Request

ID # Required Description

UserID X Requester ID #

LoanDate X Loan date (format: yyyy-mm-dd)

DocumentID X Document ID #

C ategoryID X C ategory ID #

Loan devolution date (format: yyyy-mm-dd). If not

DevolutionDate entered, the deadline according to the default deadline
specified in the document category is calculated.

ReasonID Loan reason ID #

Return

ID # Description

Status FAILURE (in case of failure) / SUC C ESS (in case of success)

C ode - Error code:

· 0 - No error (record created successfully);

· 1 - Logged user does not have permission;

· 2 - Document not found;

· 3 - C ategory not found;

· 4 - User not found;

C ode
· 5 - Required parameter not entered or entered incorrectly;

· 6 - Document already loaned out;

· 7 - Document processing;

· 8 - Document is not archived;

· 9 - Document has already been deleted;

· 10 - Reason not found;

Integration guide — SE Suite 2.0

 Integration via web services 477

Detail Message detailing the error or success in the execution of the method

RecordID Loan registration code created (in case of success) or empty (in case of failure)

Integration guide — SE Suite 2.0

 Integration via web services 478

5.2.12 - Problem

Web Services

WSDL URL: https://<domain>/se/ws/pb_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/pb_ws.php

This section displays the web services available for SE Problem. To invoke each of these methods, it is
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

cancelProblem C ancels a problem

clearChildEntityRecord Deletes all related records from form entity descending from problem

deleteChildEntityRecord Deletes a form entity record descending from problem

editAttributeValue Edits the value of attributes of a problem

editChildEntityRecord Edits a record of the form entity descending from problem

editEntityRecord Edits a form entity record from problem

executeActivity Executes a user activity or problem decision

executeSystemActivity Executes an asynchronous system activity of problem

newAssocDocument Associates a document from SE Document to a problem activity

newAttachment Attaches a file to a problem activity

newChildEntityRecord Adds a record to the form entity descending from the problem

newProblem C reates a problem record

Integration guide — SE Suite 2.0

 Integration via web services 479

5.2.12.1 - cancelProblem

This method cancels a problem.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\CancelProblemRequestType.java

Return web\wwwroot\ws\java\problem\CancelProblemResponseType.java

Request structure

<cancelProblem>
<ProblemID>?</ProblemID>
<Explanation>?</Explanation>
</cancelProblem>

Request

ID # Required Description

ProblemID X Problem ID #

Explanation X Explanation

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 480

5.2.12.2 - clearChildEntityRecord

This method deletes all related records from the form entity descending from the problem.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\ClearChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\problem\ClearChildEntityRecordResponseType.java

Request structure

<clearChildEntityRecord>
<ProblemID>?</ProblemID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
</clearChildEntityRecord>

Request

ID # Required Description

ProblemID X Problem ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 481

5.2.12.3 - deleteChildEntityRecord

This method deletes a form entity record descending from the problem.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\DeleteChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\problem\DeleteChildEntityRecordResponseType.java

Request structure

<deleteChildEntityRecord>
<ProblemID>?</ProblemID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
</deleteChildEntityRecord>

Request

ID # Required Description

ProblemID X Problem ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

C hildRecordOID X Record code related to descending form entity

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 482

5.2.12.4 - editAttributeValue

This method edits the values of the attributes of a problem.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\EditAttributeValueRequestType.java

Return web\wwwroot\ws\java\problem\EditAttributeValueResponseType.java

Request structure

<editAttributeValue>
<ProblemID>?</ProblemID>
<AttributeList>
<!--1 or more repetitions:-->
<Attribute>
<AttributeID>?</AttributeID>
<!--Zero or more repetitions:-->
<AttributeValueList>
<AttributeValue>?</AttributeValue>
</AttributeValueList>
</Attribute>
</AttributeList>
</editAttributeValue>

Request

ID # Required Description

ProblemID X Problem ID #

AttributeID X Attribute ID #

Attribute value

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand

AttributeValue separators and with period (.) as decimal separator

§ Currency: numeric digits without the thousand

separators and with period (.) as decimal separator

Integration guide — SE Suite 2.0

 Integration via web services 483

§ Date: YYYY-MM-DD

§ Hour: HHHH:MM

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 484

5.2.12.5 - editChildEntityRecord

This method edits a record of the form entity descending from the problem

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\EditChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\problem\EditChildEntityRecordResponseType.java

Request structure

<editChildEntityRecord>
<ProblemID>?</ProblemID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editChildEntityRecord>

Integration guide — SE Suite 2.0

 Integration via web services 485

Request

ID # Required Description

ProblemID X Problem ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

C hildRecordOID X Record code related to descending form entity

EntityAttributeID Form entity attribute ID #

Form entity attribute value.

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

EntityAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

RelationshipAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 486

5.2.12.6 - editEntityRecord

This method edits a form entity record from the problem.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\EditEntityRecordRequestType.java

Return web\wwwroot\ws\java\problem\EditEntityRecordResponseType.java

Request structure

<editEntityRecord>
<ProblemID>?</ProblemID>
<EntityID>?</EntityID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editEntityRecord>

Integration guide — SE Suite 2.0

 Integration via web services 487

Request

ID # Required Description

ProblemID X Problem ID #

EntityID X Form entity ID #

EntityAttributeID Form entity attribute ID #

Form entity attribute value.

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

EntityAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

RelationshipAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 488

5.2.12.7 - executeActivity

This method executes a user activity or problem decision.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\ExecuteActivityRequestType.java

Return web\wwwroot\ws\java\problem\ExecuteActivityResponseType.java

Request structure

<executeActivity>
<ProblemID>?</ProblemID>
<ActivityID>?</ActivityID>
<ActionSequence>?</ActionSequence>
<UserID>?</UserID>
</executeActivity>

Request

ID # Required Description

ProblemID X Problem ID #

ActivityID X Activity ID #

ActionSequence X Number of action sequence

UserID User ID

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 489

5.2.12.8 - executeSystemActivity

This method executes an asynchronous system activity of problem.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\ExecuteSystemActivityRequestType.java

Return web\wwwroot\ws\java\problem\ExecuteSystemActivityResponseType.java

Request structure

<executeSystemActivity>
<ProblemID>?</ProblemID>
<ActivityID>?</ActivityID>
</executeSystemActivity>

Request

ID # Required Description

ProblemID X Problem ID #

ActivityID X Activity ID #

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 490

5.2.12.9 - newAssocDocument

This method associates a document from SE Document with a problem activity

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\NewAssocDocumentRequestType.java

Return web\wwwroot\ws\java\problem\NewAssocDocumentResponseType.java

Request structure

<newAssocDocument>
<ProblemID>?</ProblemID>
<ActivityID>?</ActivityID>
<DocumentID>?</DocumentID>
</newAssocDocument>

Request

ID # Required Description

ProblemID X Problem ID #

ActivityID X Activity ID #

DocumentID X Document ID #

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 491

5.2.12.10 - newAttachment

This method attaches a file to a problem activity.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\NewAttachmentRequestType.java

Return web\wwwroot\ws\java\problem\NewAttachmentResponseType.java

Request structure

<newAttachment>
<ProblemID>?</ProblemID>
<ActivityID>?</ActivityID>
<FileName>?</FileName>
<FileContent>?</FileContent>
<UserID>?</UserID>
<AttachmentID>?</AttachmentID>
<AttachmentName>?</AttachmentName>
<Summary>?</Summary>
</newAttachment>

Request

ID # Required Description

ProblemID X Problem ID #

ActivityID X Activity ID #

FileName X File name (including its extension)

FileC ontent X Binary content of the file

UserID User ID

AttachmentID Attachment ID #

AttachmentName Attachment name

Summary Summary

Integration guide — SE Suite 2.0

 Integration via web services 492

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

RecordID ID # of the record added by the method

Integration guide — SE Suite 2.0

 Integration via web services 493

5.2.12.11 - newChildEntityRecord

This method adds a record to the form entity descending from the problem.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\NewChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\problem\NewChildEntityRecordResponseType.java

Request structure

<newChildEntityRecord>
<ProblemID>?</ProblemID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</newChildEntityRecord>

Integration guide — SE Suite 2.0

 Integration via web services 494

Request

ID # Required Description

ProblemID X Problem ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

EntityAttributeID Form entity attribute ID #

Form entity attribute value.

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

EntityAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

RelationshipAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

Integration guide — SE Suite 2.0

 Integration via web services 495

5.2.12.12 - newProblem

This method creates a problem record.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\problem\NewProblemRequestType.java

Return web\wwwroot\ws\java\problem\NewProblemResponseType.java

Request structure

<newProblem>
<ProblemTypeID>?</ProblemTypeID>
<ProblemTitle>?</ProblemTitle>
<UserID>?</UserID>
</newProblem>

Request

ID # Required Description

ProblemTypeID X Problem type ID #

ProblemTitle X Problem title

UserID User ID

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

RecordID ID # of the record added by the method

Integration guide — SE Suite 2.0

 Integration via web services 496

5.2.13 - Project

Web Services

WSDL URL: https://<domain>/se/ws/pr_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/pr_ws.php

This section displays the interfaces available for SE Project. To insert each of these items, it will be necessary
to follow the standard documented in the upcoming sections.

Available web services

Method Description

cancelRat C ancels a service report

editProgramCost Edit cost of a program

editProgramRevenue Edit revenue of a program

editProjectCost Edit cost of a project

editProjectRevenue Edit revenue of a project

editProjectTaskRevenue Edit revenue of a project task

executeProjectTask Execute a project task

newAssocDocProj Associates documents with the project or task

newProgramCost Inserts costs in a program

newProgramRevenue Inserts revenue in a program

newProjectCost Inserts cost in a project

newProjectRevenue Inserts revenue in a project

newProjectTaskCost Inserts costs in a project task

RatSent Updates service reports to make them unavailable

Returns an XML of the service reports in the approval step that were
returnRatApproval
not sent yet.

Returns an XML of the service reports in the approval step that were
returnRatApprovalOne
not sent yet.

setRatAttributeValue Assigns a value to a service report attribute:

Integration guide — SE Suite 2.0

 Integration via web services 497

5.2.13.1 - cancelRat

This method changes the status of the service report to cancelled. For this action, it is necessary to follow the
standard documented below.

Java class

Request web/wwwroot/ws/java/project/CancelRatRequestType.java

Return web/wwwroot/ws/java/project/CancelRatResponseType.java

Request

ID # Required Description

IDRAT X Service report ID #.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: 2

Integration guide — SE Suite 2.0

 Integration via web services 498

5.2.13.2 - editProgramCost

This method enables editing the cost of a program. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/project/NewProgramCostRequestType.java

Return web/wwwroot/ws/java/project/NewProgramCostResponseType.java

Request

ID # Required Description

ProgramId X Program ID #

Name X C ost name

TypeId X ID # of cost type

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 499

5.2.13.3 - editProgramRevenue

This method enables to edit the revenue of a program. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/project/EditProgramRevenueRequestType.java

Return web/wwwroot/ws/java/project/EditProgramRevenueResponseType.java

Request

ID # Required Description

ProgramId X Program ID #

Name X Revenue name for editing

TypeId X Revenue type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 500

5.2.13.4 - editProjectCost

This method enables to edit the cost of a project. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/project/EditProjectCostRequestType.java

Return web/wwwroot/ws/java/project/EditProjectCostResponseType.java

Request

ID # Required Description

ProjectId X Project ID #

Name X C ost name for editing

TypeId X ID # of cost type

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 501

5.2.13.5 - editProjectRevenue

This method enables to edit the revenue of a project. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/project/EditProjectRevenueRequestType.java

Return web/wwwroot/ws/java/project/EditProjectRevenueResponseType.java

Request

ID # Required Description

ProjectId X Project ID #

Name X Revenue name for editing

TypeId X Revenue type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 502

5.2.13.6 - editProjectTaskRevenue

This method enables to edit the revenue of a project task. For this action, it is necessary to follow the
standard documented below.

Java class

Request web/wwwroot/ws/java/project/NewProjectTaskRevenueRequestType.java

Return web/wwwroot/ws/java/project/NewProjectTaskRevenueResponseType.java

Request

ID # Required Description

ProjectId X Project ID #

ProjectTaskId Project task ID #

Name X Revenue name

TypeId X Revenue type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 503

5.2.13.7 - executeProjectTask

This method enables to execute a project task. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/project/NewAssocDocProjRequestType.java

Return web/wwwroot/ws/java/project/NewAssocDocProjResponseType.java

Request

ID # Required Description

ProjectTaskId X Project task ID #

ProjectId X Project ID #

UserId X Executor's reg. code

StartDate Actual start date (format: DD/MM/YYYY or YYYY-MM-DD)

EndDate Actual end date (formato: DD/MM/YYYY or YYYY-MM-DD)

ActualPercentage Task execution percentage

UsePlannedOrRescheduledDa Fill-in option: 1 - Apply planned dates, 2 - Apply

tes rescheduled dates

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 504

5.2.13.8 - newAssocDocProj

This method enables to associate a document with the project or with a project task. To edit it, it is necessary
to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/project/NewAssocDocProjRequestType.java

Return web/wwwroot/ws/java/project/NewAssocDocProjResponseType.java

Request

ID # Required Description

IDDOC UMENT X Document ID #

IDPROJEC T X Project ID #

IDAC TIVITY Project task ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Error message

Integration guide — SE Suite 2.0

 Integration via web services 505

5.2.13.9 - newProgramCost

This method enables to add the cost in a program. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/project/EditProjectTaskRevenueRequestType.java

Return web/wwwroot/ws/java/project/EditProjectTaskRevenueResponseType.java

Request

ID # Required Description

ProjectId X Project ID #

ProjectTaskId X Project task ID #

Name X Revenue name for editing

TypeId X Revenue type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 506

5.2.13.10 - newProgramRevenue

This method enables to add the revenue in a program. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/project/NewProgramRevenueRequestType.java

Return web/wwwroot/ws/java/project/NewProgramRevenueResponseType.java

Request

ID # Required Description

ProgramId X Program ID #

Name X Revenue name

TypeId X Revenue type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 507

5.2.13.11 - newProjectCost

This method enables to add the cost in a project. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/project/NewProjectCostRequestType.java

Return web/wwwroot/ws/java/project/NewProjectCostResponseType.java

Request

ID # Required Description

ProjectId X Project ID #

Name X C ost name

TypeId X ID # of cost type

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 508

5.2.13.12 - newProjectRevenue

This method enables to add the revenue in a project;

Java class

Request web/wwwroot/ws/java/project/NewProjectRevenueRequestType.java

Return web/wwwroot/ws/java/project/NewProjectRevenueResponseType.java

Request

ID # Required Description

ProjectId X Project ID #

Name X Revenue name

TypeId X Revenue type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 509

5.2.13.13 - newProjectTaskCost

This method enables to add the cost in a project task. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/project/NewProjectTaskCostRequestType.java

Return web/wwwroot/ws/java/project/NewProjectTaskCostResponseType.java

Request

ID # Required Description

ProjectId X Project ID #

ProjectTaskId Project task ID #

Name X C ost name

TypeId X ID # of cost type

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 510

5.2.13.14 - RatSent

This method makes the service report unavailable to be returned by the other services of returnRatApproval
and returnRatApprovalOne. For this action, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/project/RatSentRequestType.java

Return web/wwwroot/ws/java/project/RatSentResponseType.java

Request

ID # Required Description

IDRAT X Service report ID #.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: 2

Integration guide — SE Suite 2.0

 Integration via web services 511

5.2.13.15 - returnRatApproval

Returns an XML of the service reports in the approval step that were not sent yet. To edit it, it is necessary to
follow the standard documented below.

Java class

Request web/wwwroot/ws/java/project/ReturnRatApprovalRequestType.java

Return web/wwwroot/ws/java/project/ReturnRatApprovalResponseType.java

Return

ID # Description

Returns an XML of all service reports in the approval step that were not sent yet.
return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 512

5.2.13.16 - returnRatApprovalOne

Returns an XML of the service reports in the approval step that were not sent yet. To edit it, it is necessary to
follow the standard documented below.

Java class

Request web/wwwroot/ws/java/project/ReturnRatApprovalOneRequestType.java

Return web/wwwroot/ws/java/project/ReturnRatApprovalOneResponseType.java

Return

ID # Description

SUC C ESS: Returns an XML of a service report in the approval step that was not sent yet.
return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 513

5.2.13.17 - setRatAttributeValue

This method assigns a value to an attribute of the Service Report: If the attribute is not associated with a
Service Report, it will be then associated. For this action, it is necessary to follow the standard documented
below.

Java class

Request web/wwwroot/ws/java/project/SetRatAttributeValueRequestType.java

Return web/wwwroot/ws/java/project/SetRatAttributeValueResponseType.java

Request

ID # Required Description

IDRAT X Service report ID #.

IDATTRIBUTE X Attribute ID #

VLATTRIBUTE X Attribute value

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Error message

Integration guide — SE Suite 2.0

 Integration via web services 514

5.2.14 - Request

Web Services

WSDL URL: https://<domain>/se/ws/sr_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/sr_ws.php

This section displays the interfaces available for SE Request. To insert each of these items, it will be necessary
to follow the standard documented in the upcoming sections.

Available web services

Method Description

getKeyWordRequestStatus Returns the data of a keyword request status.

newKeyWordRequest C reates a keyword request

sendRequestToApprov Sends the request to the next step

Integration guide — SE Suite 2.0

 Integration via web services 515

5.2.14.1 - getKeyWordRequestStatus

This method enables to return:

§ Data of the status of a keyword request.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\servicer\GetKeyWordRequestStatusRequestType.java

Return web\wwwroot\ws\java\servicer\GetKeyWordRequestStatusResponseType.java

Request

ID # Required Description

IDREQUEST X Request ID #.

Return

ID # Description

SUC C ESS: Returns a vector with the request data:

§ NMUSEREMIT – Name of the user who issued the request.

§ DTREQUEST – Request date.

§ FGPHASE – Step the request is in:

1 – Issue

2 – Approval

3 – To be executed
return 4 – Being executed

5 – C losure

6 – Finished

7 – C ancelled

§ C ANC ELREASON - For cancelled or rejected requests; it indicates the

reason.

§ KEYWORDC REATED - For finished requests; it indicates the created keyword.

FAILURE: Returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 516

5.2.14.2 - newKeyWordRequest

This method enables to insert and edit:

§ Data of a request;

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\servicer\NewKeyWordRequestRequestType.java

Return web\wwwroot\ws\java\servicer\NewKeyWordRequestResponseType.java

Request

ID # Required Description

IDREQUEST X Request ID #

NMREQUEST X Request name

Request type ID #. The object type of the request type

IDREQUESTTYPE X should be Document, and the Operation should be blank or
with the Keyword option selected.

IDUSEREMIT X ID # of the user who issued the request

DSREQUEST X Request description

Request explanation. If the request type requires an

DSREASON X explanation to be entered, the DSREASON parameter
becomes required.

Request closure date. The date format must be Y-M-D

DTREQUESTENDDATE X
(Year-Month-Day).

Request attributes.

Example:
ID#_OF_ATTRIBUTE1=VALUE_OF_ATTRIBUTE1;ID#_OF_AT
TRIBUTE2=VALUE_OF_ATTRIBUTE2;ID#_OF_ATTRIBUTE3=
VALUE_OF_ATTRIBUTE3.

ATTRIBUTES X
Example with a multivalued attribute. Note that the
separator for the values of the multivalued attributes is a
"," (comma):
ID#_OF_ATTRIBUTE1=VALUE1_OF_ATTRIBUTE1,VALUE2_O
F_ATTRIBUTE1,VALUE3_OF_ATTRIBUTE1.

Integration guide — SE Suite 2.0

 Integration via web services 517

Note: For attributes with a numeric value, the decimal place

separator must be "." (dot). For date fields, the value must
have the “Y-M-D”(Year-Month-Day) format.

Approval route ID #. Required for requests that have

IDAPPROVALROUTE X
approval.

Return

ID # Description

SUC C ESS: Returns a ("Operation successfully performed") message

return
FAILURE: Returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 518

5.2.14.3 - sendRequestToApprov

This method enables to send a request to the next step:

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\servicer\SendRequestToApprovRequestType.java

Return web\wwwroot\ws\java\servicer\SendRequestToApprovResponseType.java

Request

ID # Required Description

IDREQUEST X Request name

Return

ID # Description

SUC C ESS: Returns a ("Operation successfully performed") message

return
FAILURE: Returns a message with the error that occurred.

Integration guide — SE Suite 2.0

 Integration via web services 519

5.2.15 - SPC

Web Services

WSDL URL: https://<domain>/se/ws/spc_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/spc_ws.php

This section displays the interfaces available for SE SPC. To insert each of these items, it will be necessary to
follow the standard documented in the upcoming sections.

Available web services

Method Description

ChangeStatusSample C hanges the status of a sample in a collection

DeleteAttCause Deletes a cause for an attribute type sample

DeleteAttDefect Deletes defects for an attribute type sample

DeleteSampleAtt Deletes an attribute type sample

DeleteSampleVar Deletes a variable type sample

ImportAttCause Imports a cause to an attribute type sample

ImportAttDefect Imports defects to an attribute type sample

ImportSampleAtt Imports an attribute type sample

ImportSampleVar Imports a variable type sample

Integration guide — SE Suite 2.0

 Integration via web services 520

5.2.15.1 - ChangeStatusSample

This method enables to change the status of a sample of a collection.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/spc/ChangeStatusSampleRequestType.java

Return web/wwwroot/ws/java/spc/ChangeStatusSampleResponseType.java

Request

ID # Required Description

IDC OLLEC T X C ollection ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDSEQUENC ESAMPLE X Sample ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 521

5.2.15.2 - DeleteAttCause

This method enables to delete the causes of defects of a sample (zeroes the causes).

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/spc/DeleteAttCauseRequestType.java

Return web/wwwroot/ws/java/spc/DeleteAttCauseResponseType.java

Request

ID # Required Description

IDC OLLEC T X C ollection ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDSEQUENC ESAMPLE X Sample ID #

IDDEFEC T X Defect ID #

IDC AUSE X C ause ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 522

5.2.15.3 - DeleteAttDefect

This method enables to delete the defects of a sample (zeroes the defects).

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/spc/DeleteAttDefectRequestType.java

Return web/wwwroot/ws/java/spc/DeleteAttDefectResponseType.java

Request

ID # Required Description

IDC OLLEC T X C ollection ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDSEQUENC ESAMPLE X Sample ID #

IDDEFEC T X Defect ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 523

5.2.15.4 - DeleteSampleAtt

This method enables to delete an attribute type sample from a collection

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/spc/DeleteSampleAttRequestType.java

Return web/wwwroot/ws/java/spc/DeleteSampleAttResponseType.java

Request

ID # Required Description

IDC OLLEC T X C ollection ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDSEQUENC ESAMPLE X Sample ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 524

5.2.15.5 - DeleteSampleVar

This method enables to delete a variable type sample from a collection

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/spc/DeleteSampleVarRequestType.java

Return web/wwwroot/ws/java/spc/DeleteSampleVarResponseType.java

Request

ID # Required Description

IDC OLLEC T X C ollection ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDSEQUENC ESAMPLE X Sample ID #

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 525

5.2.15.6 - ImportAttCause

This method enables to change the number of causes of a defect of the attribute type sample of a data
collection.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/spc/ImportAttCauseRequestType.java

Return web/wwwroot/ws/java/spc/ImportAttCauseResponseType.java

Request

ID # Required Description

IDC OLLEC T X C ollection ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDSEQUENC ESAMPLE X Sample ID #

IDDEFEC T X Defect ID #

IDC AUSE X C ause ID #

QTC AUSE X Quantity of causes

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 526

5.2.15.7 - ImportAttDefect

This method enables to change the number of defects of the attribute type sample of a data collection.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/spc/ImportAttDefectRequestType.java

Return web/wwwroot/ws/java/spc/ImportAttDefectResponseType.java

Request

ID # Required Description

IDC OLLEC T X C ollection ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDSEQUENC ESAMPLE X Sample ID #

IDDEFEC T X Defect ID #

QTDEFEC T X Quantity of defects

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 527

5.2.15.8 - ImportSampleAtt

This method enables to import an attribute type sample to a collection with attribute type characteristics.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/spc/ImportSampleAttRequestType.java

Return web/wwwroot/ws/java/spc/ImportSampleAttResponseType.java

Request

ID # Required Description

IDC OLLEC T X C ollection ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDSEQUENC ESAMPLE Sample ID #

DTSAMPLE X Sample date

TMSAMPLE X Sample time

General data configuration:

1 - Keep general data according to prior sample;

C ONFIG X
2 - Keep general data according to the characteristic
configuration.

IDMAC HINE Machine ID #

IDOPERATOR Operator ID #

IDINSPEC TOR Inspector ID #

IDSHIFT Shift ID #

IDGAGE Gage ID #

NMLOT Lot

NMMO OF

QTITENS X Quantity of items

QTDEFEC TSITEM X Quantity of defective items

QTREJEC TSITEM X Quantity of rejected items

IDPROC ESS Process ID #

Integration guide — SE Suite 2.0

 Integration via web services 528

List of defects and their respective quantities separated by

semicolon (;) and colon (:). If the ID # contains one of the
two delimiting characters, use backslash (\) as the
DEFEC T
antecedent character, according to the format:

Format:
DEFEC T01:3;DEFEC T\;02:4

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 529

5.2.15.9 - ImportSampleVar

This method enables to import a variable type sample to a collection with a variable type characteristic.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/spc/ImportSampleVarRequestType.java

Return web/wwwroot/ws/java/spc/ImportSampleVarResponseType.java

Request

ID # Required Description

IDC OLLEC T X C ollection ID #

IDC HARAC TERISTIC X C haracteristic ID #

IDSEQUENC ESAMPLE Sample ID #

DTSAMPLE X Sample date

TMSAMPLE X Sample time

General data configuration:

1 - Keep general data according to prior sample;

C ONFIG X
2 - Keep general data according to the characteristic
configuration.

IDMAC HINE Machine ID #

IDOPERATOR Operator ID #

IDINSPEC TOR Inspector ID #

IDSHIFT Shift ID #

IDGAGE Gage ID #

NMLOT Lot

NMMO OF

READINGS X Readings. E.g.: 1;2;3;4

IDPROC ESS Process ID #

Integration guide — SE Suite 2.0

 Integration via web services 530

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Returns a message regarding the error that occurred

Integration guide — SE Suite 2.0

 Integration via web services 531

5.2.16 - Supply

Web Services

WSDL URL: https://<domain>/se/ws/sp_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/sp_ws.php

This section displays the interfaces available for SE Supply. To insert each of these items, it will be necessary
to follow the standard documented in the upcoming sections.

Available web services

Method Description

addEditSupplyWarehouse Associates/Edits a storeroom with a supply

addSupplyStructure C reates a structure for the supply

createEditSupply C reates or edits a supply

createSupplyType C reates a supply type

deleteSupply Removes the supply

deleteSupplyStructure Removes a supply structure

deleteSupplyWarehouse Deletes a supply type

Integration guide — SE Suite 2.0

 Integration via web services 532

5.2.16.1 - addEditSupplyWarehouse

This method enables to associate/edit a storeroom with a supply. To insert each of these items, it is necessary
to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\supply\AddEditSupplyWarehouseRequestType.java

Return web\wwwroot\ws\java\supply\AddEditSupplyWarehouseResponseType.java

Request

ID # Required Description

IDBOJEC T X Object ID #

IDSTOREROOM X ID # of the storeroom to be associated

VLOPTIMUM Ideal quantity

VLREPLAC EMENT Min. reorder qty.

Return

ID # Description

SUC C ESS: Return regarding the executed item

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 533

5.2.16.2 - addSupplyStructure

This method enables to create/edit:

§ Data of a supply structure.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\supply\AddSupplyStructureRequestType.java

Return web\wwwroot\ws\java\supply\AddSupplyStructureResponseType.java

Request

ID # Required Description

IDBOJEC T X Asset ID #

IDREVISION X Revision ID #

IDOBJEC TOWNER X ID # (Upper level object)

IDREVISIONOWNER X Revision (Upper level object)

VLQUANTITY X Quantity

Return

ID # Description

SUC C ESS: Return regarding the executed item

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 534

5.2.16.3 - createEditSupply

This method enables to insert and edit:

§ Data of a supply.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\supply\CreateEditSupplyRequestType.java

Return web\wwwroot\ws\java\supply\CreateEditSupplyResponseType.java

Request

ID # Required Description

IDBOJEC T X Asset ID #

NMOBJEC T X Asset name.

IDOBJEC TTYPE X Asset type ID #.

IDTEAM X Responsible team ID #.

IDMEASUNITY X Measurement unit

Return

ID # Description

SUC C ESS: Return regarding the executed item

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 535

5.2.16.4 - createSupplyType

This method enables to create/edit:

§ Data of a supply type.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\supply\CreateSupplyTypeRequestType.java

Return web\wwwroot\ws\java\supply\CreateSupplyTypeResponseType.java

Request

ID # Required Description

IDOBJEC TTYPE X Supply type ID #

NMOBJEC TTYPE X Supply type name

Flag to identify whether the class will or not have a

revision:
FGUSEREVISIONOBJTYPE X
1 - Yes;

2 - No;

IDMASK Mask ID #

IDOBJEC TTYPEOWNER Upper level item type

Revision ID #:

1 – Text;

FGEDITID 2 – Numeric;

3 – C ustomized;

Will be required if the is 1

IDREVISIONROUTEOBJTYPE Route ID #

IDPROC ESSOBJTYPE Activity ID #

Revision ID #. Will be required if the

FGREVIDOBJTYPE
FGUSEREVISIONOBJTYPE is 1

Revision cycle:

FGTYPEC YC LEOBJTYPE 1 - Numeric

2 - Text

Integration guide — SE Suite 2.0

 Integration via web services 536

FGREVRETENTIONMODEOBJT Retention frequency of obsolete revisions. Will be required

YPE if the FGUSEREVISIONOBJTYPE is 1;

FGTYPEUPDATEOBJTYPE C hange: Default Numeric;

Approval type:
FGREVAPPROVALMODEOBJT
1 - Incremental;
YPE
2 - C ircular

C losure type:
FGREVRELEASEMODEOBJTYP
1 - Automatic
E
2 - Manual

Acceptance of revision in the draft step. Will be required if

FGREVELABC LAUSEOBJTYPE
the FGUSEREVISIONOBJTYPE is 1

Acceptance of revision in the review step. Will be required

FGREVC ONSC LAUSEOBJTYPE
if the FGUSEREVISIONOBJTYPE is 1

FGREVAPROVC LAUSEOBJTYP Acceptance of revision in the approval step. Will be

E required if the FGUSEREVISIONOBJTYPE is 1

Revision release type:

FGREVHOMOLOGC LAUSEOBJ
1 - AND
TYPE
2 - OR

Mandatory to enter revision reason (when starting):

FGEXPLANATIONOBJTYPE 1 - Mandatory to enter,

2 or NULL - Not mandatory to enter;

Return

ID # Description

SUC C ESS: Return regarding the executed item

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 537

5.2.16.5 - deleteSupply

This method enables to delete:

§ Data of a supply.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\supply\DeleteSupplyRequestType.java

Return web\wwwroot\ws\java\supply\DeleteSupplyResponseType.java

Request

ID # Required Description

IDBOJEC T X Asset ID #

Return

ID # Description

SUC C ESS: Return regarding the executed item

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 538

5.2.16.6 - deleteSupplyStructure

This method enables to delete:

§ Data of a supply structure.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\supply\DeleteSupplyStructureRequestType.java

Return web\wwwroot\ws\java\supply\DeleteSupplyStructureResponseType.java

Request

ID # Required Description

IDBOJEC T X Asset ID #

IDREVISION X Revision ID #

IDOBJEC TOWNER X ID # (Upper level object)

IDREVISIONOWNER X Revision (Upper level object)

Return

ID # Description

SUC C ESS: Return regarding the executed item

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 539

5.2.16.7 - deleteSupplyWarehouse

This method enables to delete:

§ Data of a supply type.

To insert each of these items, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\supply\DeleteSupplyWarehouseRequestType.java

Return web\wwwroot\ws\java\supply\DeleteSupplyWarehouseResponseType.java

Request

ID # Required Description

IDOBJEC T X Object ID #

IDSTOREROOM X ID # of the storeroom to be associated

VLOPTIMUM Ideal quantity

VLREPLAC EMENT Minimum reorder quantity

Return

ID # Description

SUC C ESS: Return regarding the executed item

return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 540

5.2.17 - Time control

Web Services

WSDL URL: https://<domain>/se/ws/wr_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/wr_ws.php

This section displays the interfaces available for SE Time control. To insert each of these items, it will be
necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

cancelRat C ancels a service report

editNonProjectTaskCost Edits cost of a nonproject task

editNonProjectTaskRevenue Edits revenue of a nonproject task

executeNonProjectTask Executes a nonproject task

newNonProjectTaskCost Inserts cost in a nonproject task

newNonProjectTaskRevenue Inserts revenue in a nonproject task

RatSent Updates service reports to make them unavailable

Returns an XML of the service reports in the approval step that were
returnRatApproval
not sent yet.

Returns an XML of the service reports in the approval step that were
returnRatApprovalOne
not sent yet.

setRatAttributeValue Assigns a value to a service report attribute:

Integration guide — SE Suite 2.0

 Integration via web services 541

5.2.17.1 - cancelRat

This method changes the status of the service report to cancelled. For this action, it is necessary to follow the
standard documented below.

Java class

Request web/wwwroot/ws/java/workforce/CancelRatRequestType.java

Return web/wwwroot/ws/workforce/project/CancelRatResponseType.java

Request

ID # Required Description

IDRAT X Service report ID #.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: 2

Integration guide — SE Suite 2.0

 Integration via web services 542

5.2.17.2 - editNonProjectTaskCost

This method to edit the cost of a nonproject task. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/workforce/EditNonProjectTaskCostRequestType.java

Return web/wwwroot/ws/java/workforce/EditNonProjectTaskCostResponseType.java

Request

ID # Required Description

NonProjectTaskId X Nonproject task ID #

Name X C ost name for editing

TypeId X C ost type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 543

5.2.17.3 - editNonProjectTaskRevenue

This method enables to edit the revenue of a nonproject task. For this action, it is necessary to follow the
standard documented below.

Java class

Request web/wwwroot/ws/java/workforce/EditNonProjectTaskRevenueRequestType.java

web/wwwroot/ws/java/workforce/EditNonProjectTaskRevenueResponseType.jav
Return
a

Request

ID # Required Description

NonProjectTaskId X Nonproject task ID #

Name X Revenue name for editing

TypeId X Revenue type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 544

5.2.17.4 - executeNonProjectTask

This method enables to execute a nonproject task. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/workforce/ExecuteNonProjectTaskRequestType.java

Return web/wwwroot/ws/java/workforce/ExecuteNonProjectTaskResponseType.java

Request

ID # Required Description

NonProjectTaskId X Nonproject task ID #

UserId X Executor's reg. code

StartDate Actual start date (format: DD/MM/YYYY or YYYY-MM-DD)

EndDate Actual end date (formato: DD/MM/YYYY or YYYY-MM-DD)

ActualPercentage Task execution percentage

Fill-in option:
UsePlannedOrRescheduledDa
1 - Apply planned dates,
tes
2 - Apply rescheduled dates

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 545

5.2.17.5 - newNonProjectTaskCost

This method enables to add the cost of a nonproject task. For this action, it is necessary to follow the standard
documented below.

Java class

Request web/wwwroot/ws/java/workforce/NewNonProjectTaskCostRequestType.java

Return web/wwwroot/ws/java/workforce/NewNonProjectTaskCostResponseType.java

Request

ID # Required Description

NonProjectTaskId X Nonproject task ID #

Name X C ost name

TypeId X C ost type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 546

5.2.17.6 - newNonProjectTaskRevenue

This method enables to add the revenue of a nonproject task. For this action, it is necessary to follow the
standard documented below.

Java class

Request web/wwwroot/ws/java/workforce/NewNonProjectTaskRevenueRequestType.java

Return web/wwwroot/ws/java/workforce/NewNonProjectTaskRevenueResponseType.java

Request

ID # Required Description

NonProjectTaskId X Nonproject task ID #

Name X Revenue name

TypeId X Revenue type ID #

Step to add:

1- Planned;
Phase X
2- Rescheduled;

3- Actual.

Date X Date (format: DD/MM/YYYY or YYYY-MM-DD)

Amount X Quantity

UnitValue X Unit value

DocumentNumber Document number

Description Description

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Record code.

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 547

5.2.17.7 - RatSent

This method makes the service report unavailable to be returned by the other services of returnRatApproval
and returnRatApprovalOne. For this action, it is necessary to follow the standard documented below.

Java class

Request web/wwwroot/ws/java/workforce/RatSentRequestType.java

Return web/wwwroot/ws/java/workforce/RatSentResponseType.java

Request

ID # Required Description

IDRAT X Service report ID #.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: 2

Integration guide — SE Suite 2.0

 Integration via web services 548

5.2.17.8 - returnRatApproval

Returns an XML of the service reports in the approval step that were not sent yet. To edit it, it is necessary to
follow the standard documented below.

Java class

Request web/wwwroot/ws/java/workforce/ReturnRatApprovalRequestType.java

Return web/wwwroot/ws/java/workforce/ReturnRatApprovalResponseType.java

Return

ID # Description

Returns an XML of all service reports in the approval step that were not sent yet.
return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 549

5.2.17.9 - returnRatApprovalOne

Returns an XML of the service reports in the approval step that were not sent yet. To edit it, it is necessary to
follow the standard documented below.

Java class

Request web/wwwroot/ws/java/workforce/ReturnRatApprovalOneRequestType.java

Return web/wwwroot/ws/java/workforce/ReturnRatApprovalOneResponseType.java

Return

ID # Description

SUC C ESS: Returns an XML of a service report in the approval step that was not sent yet.
return
FAILURE: -1

Integration guide — SE Suite 2.0

 Integration via web services 550

5.2.17.10 - setRatAttributeValue

This method assigns a value to an attribute of the Service Report: If the attribute is not associated with a
Service Report, it will be then associated. For this action, it is necessary to follow the standard documented
below.

Java class

Request web/wwwroot/ws/java/workforce/SetRatAttributeValueRequestType.java

Return web/wwwroot/ws/java/workforce/SetRatAttributeValueResponseType.java

Request

ID # Required Description

IDRAT X Service report ID #.

IDATTRIBUTE X Attribute ID #.

VLATTRIBUTE X Attribute value.

Return

ID # Description

SUC C ESS: 1
return
FAILURE: Error message

Integration guide — SE Suite 2.0

 Integration via web services 551

5.2.18 - Workflow

Web Services

WSDL URL: https://<domain>/se/ws/wf_ws.php?wsdl

Web Service URL: https://<domain>/softexpert/webserviceproxy/se/ws/wf_ws.php

This section displays the web services available for SE Workflow. To invoke each

of these methods, it is necessary to follow the standard documented in the upcoming sections.

Available web services

Method Description

cancelWorkflow C ancels a workflow

Deletes all related records from the form entity descending from
clearChildEntityRecord
workflow

deleteChildEntityRecord Deletes a form entity record descending from workflow

editAttributeValue Edits the value of attributes of a workflow

editChildEntityRecord Edits an entity form descending from the workflow

editEntityRecord Edits an entity record from workflow form

executeActivity Executes a user activity or workflow decision

executeSystemActivity Executes an asynchronous system activity of workflow

newAssocDocument Associates a document from SE Document to a workflow activity

newAttachment Attaches a file to a workflow activity

newChildEntityRecord Adds a record to the form entity descending from the workflow

newWorkflow Starts a workflow

newWorkflowUpdateData Starts a workflow and changes its data

Integration guide — SE Suite 2.0

 Integration via web services 552

5.2.18.1 - cancelWorkflow

This method cancels a workflow.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\CancelWorkflowRequestType.java

Return web\wwwroot\ws\java\workflow\CancelWorkflowResponseType.java

Request structure

<cancelWorkflow>
<WorkflowID>?</WorkflowID>
<Explanation>?</Explanation>
</cancelWorkflow>

Request

ID # Required Description

WorkflowID X Workflow ID #

Explanation X Explanation

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 553

5.2.18.2 - clearChildEntityRecord

This method deletes all related records from the form entity descending from the workflow

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\ClearChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\incident\ClearChildEntityRecordResponseType.java

Request structure

<clearChildEntityRecord>
<WorkflowID>?</WorkflowID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
</clearChildEntityRecord>

Request

ID # Required Description

WorkflowID X Workflow ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 554

5.2.18.3 - deleteChildEntityRecord

This method deletes a form entity record descending from the workflow.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\DeleteChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\workflow\DeleteChildEntityRecordResponseType.java

Request structure

<deleteChildEntityRecord>
<WorkflowID>?</WorkflowID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
</deleteChildEntityRecord>

Request

ID # Required Description

WorkflowID X Workflow ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

C hildRecordOID X Record code related to descending form entity

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 555

5.2.18.4 - editAttributeValue

This method edits the value of the attributes of a workflow

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\EditAttributeValueRequestType.java

Return web\wwwroot\ws\java\workflow\EditAttributeValueResponseType.java

Request structure

<editAttributeValue>
<WorkflowID>?</WorkflowID>
<AttributeList>
<!--1 or more repetitions:-->
<Attribute>
<AttributeID>?</AttributeID>
<!--Zero or more repetitions:-->
<AttributeValueList>
<AttributeValue>?</AttributeValue>
</AttributeValueList>
</Attribute>
</AttributeList>
</editAttributeValue>

Request

ID # Required Description

WorkflowID X Workflow ID #

AttributeID X Attribute ID #

Attribute value

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand

AttributeValue separators and with period (.) as decimal separator

§ Currency: numeric digits without the thousand

separators and with period (.) as decimal separator

Integration guide — SE Suite 2.0

 Integration via web services 556

§ Date: YYYY-MM-DD

§ Hour: HHHH:MM

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 557

5.2.18.5 - editChildEntityRecord

This method edits an entity form descending from the workflow.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\EditChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\workflow\EditChildEntityRecordResponseType.java

Request structure

<editChildEntityRecord>
<WorkflowID>?</WorkflowID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<ChildRecordOID>?</ChildRecordOID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editChildEntityRecord>

Integration guide — SE Suite 2.0

 Integration via web services 558

Request

ID # Required Description

WorkflowID X Workflow ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

C hildRecordOID X Record code related to descending form entity

EntityAttributeID Form entity attribute ID #

Form entity attribute value.

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

EntityAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

RelationshipAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 559

5.2.18.6 - editEntityRecord

This method edits an entity record from the workflow form.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\EditEntityRecordRequestType.java

Return web\wwwroot\ws\java\workflow\EditEntityRecordResponseType.java

Request structure

<editEntityRecord>
<WorkflowID>?</WorkflowID>
<EntityID>?</EntityID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</editEntityRecord>

Integration guide — SE Suite 2.0

 Integration via web services 560

Request

ID # Required Description

WorkflowID X Workflow ID #

EntityID X Form entity ID #

EntityAttributeID Form entity attribute ID #

Form entity attribute value.

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

EntityAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

RelationshipAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 561

5.2.18.7 - executeActivity

This method executes a user activity or workflow decision.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\ExecuteActivityRequestType.java

Return web\wwwroot\ws\java\workflow\ExecuteActivityResponseType.java

Request structure

<executeActivity>
<WorkflowID>?</WorkflowID>
<ActivityID>?</ActivityID>
<ActionSequence>?</ActionSequence>
<UserID>?</UserID>
</executeActivity>

Request

ID # Required Description

WorkflowID X Workflow ID #

ActivityID X Activity ID #

ActionSequence X Number of action sequence

UserID User ID

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 562

5.2.18.8 - executeSystemActivity

This method executes an asynchronous system activity of workflow.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\ExecuteSystemActivityRequestType.java

Return web\wwwroot\ws\java\workflow\ExecuteSystemActivityResponseType.java

Request structure

<executeSystemActivity>
<WorkflowID>?</WorkflowID>
<ActivityID>?</ActivityID>
</executeSystemActivity>

Request

ID # Required Description

WorkflowID X Workflow ID #

ActivityID X Activity ID #

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 563

5.2.18.9 - newAssocDocument

This method associates a document from SE Document with a workflow activity

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\NewAssocDocumentRequestType.java

Return web\wwwroot\ws\java\workflow\NewAssocDocumentResponseType.java

Request structure

<newAssocDocument>
<WorkflowID>?</WorkflowID>
<ActivityID>?</ActivityID>
<DocumentID>?</DocumentID>
</newAssocDocument>

Request

ID # Required Description

WorkflowID X Workflow ID #

ActivityID X Activity ID #

DocumentID X Document ID #

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

Integration guide — SE Suite 2.0

 Integration via web services 564

5.2.18.10 - newAttachment

This method attaches a file to a workflow activity.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\NewAttachmentRequestType.java

Return web\wwwroot\ws\java\workflow\NewAttachmentResponseType.java

Request structure

<newAttachment>
<WorkflowID>?</WorkflowID>
<ActivityID>?</ActivityID>
<FileName>?</FileName>
<FileContent>?</FileContent>
<UserID>?</UserID>
<AttachmentID>?</AttachmentID>
<AttachmentName>?</AttachmentName>
<Summary>?</Summary>
</newAttachment>

Request

ID # Required Description

WorkflowID X Workflow ID #

ActivityID X Activity ID #

FileName X File name (including its extension)

FileC ontent X Binary content of the file

UserID User ID

AttachmentID

AttachmentName Attachment name

Summary Summary

Integration guide — SE Suite 2.0

 Integration via web services 565

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

RecordID ID # of the record added by the method

Integration guide — SE Suite 2.0

 Integration via web services 566

5.2.18.11 - newChildEntityRecord

This method adds a record to the form entity descending from the workflow.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\NewChildEntityRecordRequestType.java

Return web\wwwroot\ws\java\workflow\NewChildEntityRecordResponseType.java

Request structure

<newChildEntityRecord>
<WorkflowID>?</WorkflowID>
<MainEntityID>?</MainEntityID>
<ChildRelationshipID>?</ChildRelationshipID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?</RelationshipAttributeValue>
</RelationshipAttribute>
</Relationship>
</RelationshipList>
</newChildEntityRecord>

Integration guide — SE Suite 2.0

 Integration via web services 567

Request

ID # Required Description

WorkflowID X Workflow ID #

MainEntityID X Main form entity ID #

C hildRelationshipID X Relationship ID # of the descending entity form

EntityAttributeID Form entity attribute ID #

Form entity attribute value.

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

EntityAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity

Notes according to the attribute type:

§ Numeric: numeric digits without the thousand or

decimal separator

RelationshipAttributeValue § Decimal: numeric digits without the thousand

separators and with period (.) as decimal separator

§ Date: YYYY-MM-DD

§ Hour: HH:MM

§ Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

Integration guide — SE Suite 2.0

 Integration via web services 568

5.2.18.12 - newWorkflow

This method starts a workflow.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\NewWorkflowRequestType.java

Return web\wwwroot\ws\java\workflow\NewWorkflowResponseType.java

Request structure

<newWorkflow>
<ProcessID>?</ProcessID>
<WorkflowTitle>?</WorkflowTitle>
<UserID>?</UserID>
</newWorkflow>

Request

ID # Required Description

ProcessID X Process ID #

WorkflowTitle X Workflow title

UserID User ID

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

RecordID ID # of the record added by the method

Integration guide — SE Suite 2.0

 Integration via web services 569

5.2.18.13 - newWorkflowUpdateData

This method starts a workflow and changes its data.

To invoke this method, it is necessary to follow the standard documented below.

Java class

Request web\wwwroot\ws\java\workflow\NewWorkflowUpdateDataRequestType.java

Return web\wwwroot\ws\java\workflow\NewWorkflowUpdateDataResponseType.java

Request structure

<newWorkflowUpdateData
<ProcessID>?</ProcessID>
<WorkflowTitle>?</WorkflowTitle>
<UserID>?</UserID>
<EntityList>
<Entity>
<EntityID>?</EntityID>
<EntityAttributeList>
<!--Zero or more repetitions:-->
<EntityAttribute>
<EntityAttributeID>?</EntityAttributeID>
<EntityAttributeValue>?</EntityAttributeValue>
</EntityAttribute>
</EntityAttributeList>
<RelationshipList>
<!--Zero or more repetitions:-->
<Relationship>
<RelationshipID>?</RelationshipID>
<RelationshipAttributeList>
<!--1 or more repetitions:-->
<RelationshipAttribute>
<RelationshipAttributeID>?</RelationshipAttributeID>
<RelationshipAttributeValue>?
</RelationshipAttributeValue>
</RelationshipAttribute>

Integration guide — SE Suite 2.0

 Integration via web services 570

</RelationshipAttributeList>
</Relationship>
</RelationshipList>
<EntityAttributeFileList>
<!--Zero or more repetitions:-->
<EntityAttributeFile>
<EntityAttributeID>?</EntityAttributeID>
<FileName>?</FileName>
<FileContent>?</FileContent>
</EntityAttributeFile>
</EntityAttributeFileList>
</Entity>
</EntityList>
<AttributeList>
<!--1 or more repetitions:-->
<Attribute>
<AttributeID>?</AttributeID>
<!--Zero or more repetitions:-->
<AttributeValueList>
<AttributeValue>?</AttributeValue>
</AttributeValueList>
</Attribute>
</AttributeList>
</newWorkflowUpdateData

Integration guide — SE Suite 2.0

 Integration via web services 571

Request

ID # Required Description

ProcessID X Process ID #

WorkflowTitle X Workflow title

UserID X User ID

EntityID Form entity ID #

EntityAttributeID Form entity attribute ID #

Form entity attribute value. Notes according to the attribute

type:

· Number: numeric digits without thousands or decimal

separators

EntityAttributeValue · Decimal: numeric digits without thousands separators

and with period (.) as decimal separator

· Date: YYYY-MM-DD

· Hour: HH:MM

· Boolean: 0 or 1

RelationshipID Relationship ID #

RelationshipAttributeID Attribute ID # of the related form entity

Attribute value of related form entity Notes according to the

attribute type:

· Number: numeric digits without thousands or decimal

separators

RelationshipAttributeValue · Decimal: numeric digits without thousands separators

and with period (.) as decimal separator

· Date: YYYY-MM-DD

· Hour: HH:MM

· Boolean: 0 or 1

FileName File name (including its extension)

FileC ontent Binary content of the file

AttributeID Attribute ID #

Attribute value. Notes according to the attribute type:

· Numeric: numeric digits without thousands or decimal

separators
AttributeValue
· C urrency: numeric digits without thousands separators
and with periods (.) as decimal separators

· Date: YYYY-MM-DD

Integration guide — SE Suite 2.0

 Integration via web services 572

· Hour: HHHH:MM

Boolean: 0 or 1

Return

ID # Description

Method execution status. Its value may be:

Status SUC C ESS: Method executed successfully

FAILURE: An error occurred during the method execution

C ode Method return code

Detail Method return detail

RecordKey C ode of the record added by the method

RecordID ID # of the record added by the method

Integration guide — SE Suite 2.0

 Update history 573

Chapter VI

Update history
The table below describes the main changes made to this document.

Revision Version Change description

16 2.0.10 Dec/11/2017
ð Update of the following interfaces:
§ Risk RISC ONTROL – C ontrol
§ Risk RISRISK – Risk
§ Asset ASTOEE - Insertion of parameter data to calculate OEE
§ Asset ASTSEC U - Asset type security import
§ PDM ITSEC U - Item type security import
§ Project PROFINANC E - Financial import
§ Administration disableUser
§ Administration ADMUSRC OMP - Full import of user data
ð Addition of interface of the following components:
§ Administration ADMEMPLOYEEPROF – Edits the employee profile data
§ Time control editNonProjectTaskC ost
§ Time control editNonProjectTaskRevenue
§ Time control executeNonProjectTask
§ Time control newNonProjectTaskC ost
§ Time control newNonProjectTaskRevenue
§ Performance addMeasuresInAdinterface
§ Project editProgramC ost
§ Project editProgramRevenue
§ Project editProjectC ost
§ Project editProjectRevenue
§ Project editProjectTaskRevenue
§ Project executeProjectTask
§ Project newProgramC ost
§ Project newProjectRevenue
§ Project newProjectTaskC ost
§ Project setRatAttributeValue
ð Update of the webservices of the following components:
§ Administration DeleteUserAcessGroup
ð Inclusão de web services dos seguintes componentes:
§ Administration updateEmployeeProfile
§ Physical file newPhysicalFileLoan
ð C hange in Interface data template:
§ Added new NMFIELDs columns (From NMFIELD76 to NMFIELD 101) and DSFIELD
columns (from DSFIELD06 to DSFIELD15).
ð C hange in Definition of the XLS file structure
§ Added the new columns of the Interface data template.
15 2.0.9 OCT/18/2017
ð Update of the following interfaces:
§ Risk RIC ONTROLATTRIBUTE - C ontrol attribute value
§ Risk RIRISKATTRIBUTE – Risk attribute value
ð Update of the following interfaces:
§ Asset ASTSEC U - Asset type security import
§ Asset ASTTYPE - Import of asset types
ð Update of the webservices of the following components:
§ PDM addSupplier
ð Interfaces of SE Generic have been moved to SE Administration: ADMTEAM and
ADMTEAMASSOC .
14 2.0.9 SEP/19/2017
ð Addition of the following interfaces:
§ Asset ASTPLANAC T - Activity plan import
§ C ompetence C PTREG - C ompetence

Integration guide — SE Suite 2.0

 Update history 574

§ Risk RIC ONTROLATTRIBUTE - C ontrol attribute value

§ Risk RIRISKATTRIBUTE – Risk attribute value
ð Update of the following interfaces:
§ Storeroom STMINPUTOBJEC T - Import of input/output event objects
§ Training TRASSOC - Evaluation and/or participant association
§ Training TRREG - Training record
ð Addition of webservices of the following components:
§ Asset importPlanActivity
§ Workflow newWorkflowUpdateData
ð Update of the webservices of the following components:
§ Administration disableUser
§ Administration NewUser
ð Removal of the webservice of the following components:
§ Administration SynchUser
13 2.0.8 Aug/14/2017
ð Addition of the following interfaces:
§ Administration ADMAC T – Import of activity
§ Administration ADMADP – Import of relationship of activity with position or
department
ð Update of the following interfaces:
§ Administration ADMUSR - User data import
ð Update of the webservices of the following components:
§ Administration SynchUser
§ Administration disableUser
12 2.0.8 Jun/13/2017
ð Addition of the following interfaces:
§ Time control WRFINANC E - Financial import
§ Time control WRRESOURC E - Resource value import
§ Time control WRTIME - Timesheet import
§ Performance STRMETRIC - Indicator import
§ Performance STRSC METRIC - Scorecard indicator import
ð Update of the following interfaces:
§ Project PRORESOURC E - Resource value import
§ Project PROTIME - Timesheet import
§ Performance STRSC ITEM - Item structure import
ð Update of the webservices of the following components:
§ Administration
§ Asset
§ C alibration
§ SPC
§ Time control
§ Document
§ Generic
§ Inspection
§ Supply
§ Maintenance
§ PDM
§ Project
§ Request
11 2.0.7 May/16/2017
ð Addition of the INSATTR - Association of attributes with the supply interface.
10 2.0.7 Mar/27/2017
ð Web service inclusion:
§ Maintenance createC orrectiveMaintenance
ð Web service update:
§ Administration EditUser
§ Administration SynchUser
09 2.0.6 Feb/22/2017
ð Interface update:
§ Asset ASTSTRC - Asset structure import
§ Asset ASTAST - Import of assets
§ SPC SPC SAMPC HANGESTATUS – C hange sample status
§ PDM ITBOM - Item structure import
§ Project PROTIME - Timesheet import
ð Web service update:
§ Asset import_asset
§ Asset import_asset_structure_insert_update

Integration guide — SE Suite 2.0

 Update history 575

§ Asset import_attrib_assoc
§ SPC ImportSampleAtt
§ PDM addBom
08 2.0.5 Oct/24/2016
ð Interface update:
§ Project PROFINANC E - Financial import
ð Interface insertion:
§ SPC SPC SAMPC HANGESTATUS – C hange sample status
ð Web service inclusion:
§ SPC C hangeStatusSample
07 2.0.5 Oct/11/2016
ð Interface insertion:
§ Administration ADMATRPROFVL - Employee profile attribute value
ð Web service inclusion:
§ Administration addAttribProfileValue
06 2.0.4 Aug/23/2016
ð Interface insertion:
§ Survey SRVGUESTUSER - Guest respondent
§ Test TSTGUESTUSER - Guest respondent
ð Update of the following interface:
§ Inspection IPQUAL - Import of the inspection qualifications
§ Inspection IPREC - Receiving inspection
05 2.0.4 Jul/06/2016
ð Inclusion of interfaces MNMAINTMETER – Meter reading and MNMAINTVARIABLE –
Variable reading.
ð Inclusion of the web services of the SE Maintenance component.
ð Update of the AddAttribute web service.
04 2.0.3 May/17/2016
ð Inclusion of the web services of the SE Time control component.
ð Inclusion of note in the Integration via web services section.
ð Update of the PRORESOURC E - Resource values import interface.
03 2.0.2 Feb/25/2016
ð Inclusion of note in the Basic HTTP authentication section.
ð Update of the following interface:
§ Training TRREG - Training record
ð Inclusion of the following interface:
§ Maintenance MNMAINTC ORREC T – C orrective maintenance import
ð Inclusion of the web services of the following components:
§ Incident
§ Problem
ð Update of the web services of the following components:
§ Administration
§ Asset
§ C alibration
§ Document
§ Inspection
§ PDM
§ Workflow
02 2.0.2 Dec/03/2015
ð Update of the component interfaces:
§ Risks
ð Update of the web services of the following components:
§ Administration
§ Asset
§ C alibration
§ SPC
§ Generic
§ Inspection
§ PDM
§ Request
01 2.0.1 Nov/20/2015
ð Update of the following interfaces:
§ Administration ADMATR - Import of attributes
§ Asset ASTAST - Import of assets and ASTASTATT - Asset attributes import
ð Update of the web services of the following components:
§ Administration

Integration guide — SE Suite 2.0

 Update history 576

§ Asset
§ Document
§ PDM
00 2.0.0 Sep/01/2015
ð C reation of the document from the "SE Suite 1.3 - Integration guide" document.

Integration guide — SE Suite 2.0

 Company

SoftExpert is a Market leader in software and services for enterprise-wide business process
improvement and compliance management, providing the most comprehensive application suite
to empower organizations to increase business performance at all levels and to maximize
industry-mandated compliance and corporate governance programs

Founded in 1995 and with more than 2,000 customers and 300,000 users worldwide, SoftExpert
solutions are used by leading corporations in all kinds of industries, including manufacturing,
government and public sector, pharmaceutical sector, hospitals and laboratories, financial
services, high tech and IT, education, energy and utilities, logistics, retail, services, among
others.

Along with its extensive network of resellers spread across all continents, SoftExpert also
provides hosting, implementation, post-sales support, and validation services for its solutions to
ensure that customers realize the maximum value from their investments.

Copyright © SoftExpert Software - Software for Performance Excellence

All rights reserved.