Framework:Transport
The Transport is used for a simple transfer of objects between several systems. Only structures are transferred without table content, dimension and so on. For a clean transport it is required that the source system equals the target system before the update and that no more objects are created on the target system.
There is also the possibility to start the import as Batch-Job to execute an automatic transport during the night.
Configuration parameter
SvrConfig.xml
Authentication of the automatic transport occurs always using SSPI with user context of the caller. This user has to be entered in the field TransportUserName in SrvConfig.xml due to security regulations.
Coplanner.exe.config
Visibility of "Transport" and "Checks on the client side" in developer mode on the client is configured by ShowTransportEntries.
Open transport
To open the transport it is necessary to be logged in as Manufacturer, PowerUser or Partner-Mode. You can find the transport in the developer mode accessible via CoPlanner.
Using this button the following dialog is opened.
Set reference date
This reference date is used for initial date selection at the export and indicates from which date objects should be considered to transport. This suggestion can be overrided using the assistant. It is recommended to execute the actual reference date if the system was just copied as development system from a productive system.
To set the reference date click 'set reference date' and 'start assistant'. Afterwards a request is shown if you would like to set the actual date as reference date. The reference date will be set at each export automatically to the date and time of the export.
Export
To start an export select Export and click "Start assistent". A new dialog will be opened to select the date from which updates should be displayed. Standard value is the date of the reference date which can be set with "Set reference date" or is overtaken by the last export. This date can be set on any date. Using the actualisation button beside the date picker the date can be re-set to the reference date. Using Ctrl+Click on the actualisation button the date will be set to 01.01.0001.
"Next" shows a list of elements which have been changed after the selected date. This list is separated in Object Administration, BI-Center an style sheets. It is not possible to select folders extra because these folders are always exported with the associated object.
In that dialog objects are displayed with date of the last change and they can be selected or unselected for the export. The context menu on the left column offers the possibility to select or unselect all objects and to generate a .csv export of the list. These columns are exported: Name, ObjectType, ObjectTypeDetail, ModDate, ModDateDe, Path. In the below section a search field is available. A click on the number of search results will activate all search results for the export.
"Finish" asks for a storage location and name of the export package. Afterwards the package is created and an information is shown when the transport is finished.
Hint These objects are excluded from export/import:
|
Hint These system objects are excluded from export/import:
|
Import
To start an import select import and click "Start assistent"
A new dialog will be opened to select the package which should be transferred.
A List of objects is shown which can be imported. Here you have also the possibility to select or unselect objects. The context menu on the left column offers again the possibility to select or unselect all objects. Additionally, there exists an option to import only objects which already exist in the system. In that overview you can also see the changes which have been made. Only field changes and dimensions- respectively Lookup-Changes are shown here. Changes like plan related are not shown separately but imported too. If you have selected all appropriate objects you can go further with "Next".
Now system checks are operated to prove if the import can be executed successfully. If that check was successful the message "The model rigidity check provides no errors or inconsistencies" is shown. If inconsistencies exist they are displayed. Finish will execute the import.
| Hint If a mask is imported which already exists in the system it will be overwritten and all existing user views will be deleted. |
| Hint If the Object Administration or BI-Center is open during the import it is recommended to make a refresh of the Object Administration. |
| Hint If the name of tables etc. is changed on the source system and then transferred to the target system a name/id conflict will occur.
These objects have to be renamed to the new name on the target system to execute a transport. At a manual import these objects are not selectable for an import they are just shown for information purposes. |
| Hint Import of table with calculated measures If a new table is imported it is possible that warnings are raised inside the logging. The reason is that an actualisation of the table will be done afterwards and therefore the fields are not identified. After a completed transport these calculated measures are transferred correctly and there are no further errors with that calculated measures. |
Import via Batch-Job
It is possible to start an import via a Batch-Job. For these imports it is required that the model rigidity checks are executed successfully before the import.
A transport can be started using this syntax: Coplanner.exe "<ServerAdress>" "<Port>" "Transport=<FullyQualifiedFileNameToTransport>"
Example:
Coplanner.exe "localhost" "8964" "Transport=c:\temp\testtransport.zip"Transfer mode is always native and can not be changed.
After an automated import the macro "PostTransportMacro" will be executed if available. This macro has not to exist at an specified position inside the Object Administration. You can specify inside this macro for example that a CreateViews is executed.
Log-Rows of an import via Batchfile include the prefix [TRB].
Example of a Batchfile:
@echo off
start /wait Coplanner.exe "localhost" "8964" "Transport=c:\temp\myTransportPackage.zip"
IF %ERRORLEVEL% EQU 0 (
ECHO Transport finished with Exit Code 0
)
IF %ERRORLEVEL% NEQ 0 (
ECHO A problem occurred. See log for details.
ECHO Error: %ERRORLEVEL%
)
IF %ERRORLEVEL% EQU 5 (
ECHO Detail: Could not establish connection to server after 10 retries.
)
IF %ERRORLEVEL% EQU 11 (
ECHO Detail: Transport was cancelled because previous check was not successful. See server log for details.
)
IF %ERRORLEVEL% EQU 15 (
ECHO Detail: Transport was executed but the check of the target system was not successful. See server log for details.
)
pause