Changelog Companion for Delivery

5.4.4

Released on 2024-11-15

Bug fix

Fixed cyclical dependencies detection in tests.
Fixed a false positive test results that could occur in very specific conditions.

5.4.3

Released on 2024-08-21

Bug fix

Potential failure of c4d license offline usage

5.4.2

Released on 2024-02-16

Bug fix

XML elements having the same tag are now sorted using their attributes.
The documentation and decompiler goals now exports nodes present inside the export configuration.

5.4.0

Released on 2023-11-03

Compiler has been improved to recompile only modified files

The way the compiler works has been revised to allow only files that have been modified to be compiled, thus saving a very important time factor when compiling again.

Three things have been put in place to achieve this:

the compiler now cleans the output directory /target/classes/step between compilations in order to support perimeter changes.
the compiler generates files in a buffer directory /target/companion-generated/output before copying the necessary files to the output directory in order to have a cache between different compilations.
the compiler is now able to determine which files a .companion.[xlsx|xlsm|csv|xml] file depends on. This makes it possible, for example, to recompile if a javascript file is modified.

To take advantage of this improvement, simply stop performing mvn clean between two compilations.

Adding parameterised tests

It is now possible to run parameterised tests in Companion for Delivery tests.

Developer -> Tests -> Parameterized Tests

Improvements

A new twirl extension has been added @files(path) which allows you to import all the files in a directory
The decompiler and portal splitter have been modified to use the @files extension to import screens. This eliminates the need to list screens in the .companion.template.xml file.

Bug fix

Warnings were present when using the latest version of maven. This is no longer the case with version 3.9.4 of maven.

5.3.0

Released on 2023-09-01

New features

Decompiler can generate file using Companion twirl templates

Companion for Delivery now depends on version 4.0.0 of Companion Templates, this version can still be overridden in the pom.xml

This new dependency allow to add an option useTemplate in the Decompiler to generate .companion.xml files that use templates when it's possible.

If you are already using an older version of Companion Twirl Templates, you must upgrade to at least version 4.0.0 to use this feature. See Companion Twirl Templates changelog.

Developer -> Decompiler

Decompiler without using hierarchy for directories

A new option flattenByType allows you to decompile without using the STEP hierarchy to distribute decompiled elements in different directories.

Developer -> Decompiler

Improvements

Excel sheets that are hidden are no longer taken into account in compilation without the need to comment them.

Bug fix

Decompiling assets into XML produced spaces around the content, which is not supported on import and produced an error.
The STEPWorkflowProfiles objects were decompiled in .companion.csv or .companion.xlsx files and produced non-readable content. It is now done in .companion.xml files with readable content.
The presence of \u in a .companion.xml file now throws an exception to warn of the lack of support for unicode characters. A new section has been written in the troubleshooting for this.
Compiling a ListOfValue without values raised an error and stopped compilation.

Excel files containing macros can now be compiled in the same way as standard Excel files. To do this, they must have the extension .companion.xlsm and the cell values must have been calculated before compilation.

Support of Business Function in tests

Business functions can now be called in unit tests in the same way as business rules in order to perform tests.

Improvements

During compilation, temporary files generated by Excel are no longer taken into account in order to avoid crashes.
Multiple improvements in the archetype : Addition of VSCode autocompletion, updated version of twirl templates and correction of incorrect files.
Improved error messages from the diff goal, with an example of how to use the goal

Bug fix

The documentation goal failed when it was run outside the project root folder.
In some error cases, the message "no body" was displayed even if the server returned a response.
The diff goal failed if some files were not in UTF-8 format.

5.1.0

Released on 2023-01-09

New features

Decompiler add BOM

Decompiler has a new parameter to add a BOMopen in new window to the generated CSV files so that Excel opens the files with the correct encoding : addBOM (false by default)

Deploy status

Deploy has a new parameter to test the status of the environment for deployment instead of deploying : -Dstatus

Improvements

The version of scala embedded in the twirl files (.companion.xml and .companion.template.xml) has been increased to version 2.13. If the Twirl Templates dependency is used in your project, you must use at least version 2.2.0
The .companion.template.xml files are no longer compiled when you choose a perimeter that includes nothing for the module
A cache has been added to avoid recompiling too many files when compiling .companion.xml and .companion.template.xml files

5.0.5

Released on 2022-12-16

Bug fix

When the parameter Restapi.Integrationendpoints.Upload.Autoinvoke is set to false in the STEP server configuration, IIEPs are not automatically invoked after uploading a file. A parameter has been added to handle this case.

This fix has also been made in version 4.2.2

5.0.4

Released on 2022-12-02

Bug fix

The diff feature only generates a report file for the first difference encountered
The diff could be in error if it detected the addition of a file
The number of added and deleted lines displayed in the diff was wrong
When duplicate insensitive case IDs are detected, we now put both objects in the same file instead of extracting only one

5.0.3

Released on 2022-10-06

Bug fix

Fix wrong line number in CSV file compilation errors if the file contains data on multiple lines
Updating the Companion Ext version to use the latest version (10.3.1)

5.0.2

Released on 2022-09-20

Bug fix

Fixed Companion unit tests that could no longer be run with the Rest API V2
Fixed the Companion for Delivery archetype, which contained unit test examples from an older version

5.0.1

Released on 2022-09-19

Improvements

Correction of the Companion for Delivery archetype which had not been fully migrated following the 5.0.0 breaking change and which no longer respected all the good practices.
Extraction of views on AttributeGroups that were illegible in the CSV/XLSX file
Displaying business rule execution errors when running unit tests
Adding the missing import to the decompilation and portal splitter in the .companion.template.xml file of the portals

Bug fix

A velocity.log file was created in the root of the project with no content when using c4d:diff.
Withdrawal of the correction made in version 5.0.0 on test files containing too many tests. This causes another error.
Correction of the order of the business libraries embedded in the tests.

5.0.0

Released on 2022-09-12

Breaking Change

Companion for Delivery 5.0.0 is not retro-compatible with previous versions.

To use version 5.0.0 of Companion for Delivery you must follow the migration procedure. Most of the migration has been automated.

How to migrate from 4.2.1 to 5.0.0

New features

Documentation

The documentation job has been completely reworked to address the authentication and performance issues we were experiencing.
This redesign was also an opportunity to completely revise the UI of the generated site.

The documentation section in the c4d-maven-plugin configuration has been removed.
The portal documentation is not part of the scope of this redesign.

More information on how to use the documentation goal

Diff

A new goal has been developed to allow easy comparison of 2 STEPXML.
It can be a file or directly an export from an environment.

More information on how to use the diff goal: Developer -> Diff

Test

Companion for delivery testing capacibilities have been enhanced :

Support Javascript testing RESTAPI from Step configuration management component. Improves testing time and allows to roll back all changes made by the tests
Possibility to integrate business libraries directly into your tests. By default a business library is provided by the Step environment, to use the right version you must compile and deploy it before launching the tests
Display of test logs in c4d console, usefull for debugging Business Rules
Support for Jasmine API autocompletion inside companion tests (Jasmine is a javascript testing framework embedded by c4d)
Supply of Companion customized Jasmine matchers adapted to the STEP api

More information about new test features : Developer -> Tests -> Companion for Delivery tests -> Rollback

Improvements

Further modification of sorting during decompilation to ensure a more consistent order and to reduce false modifications when using the diff
Added a specific way to decompile UserGroups. Privileges and SetupGUI are now placed in separate files
Addition of level 2 of STEPXML in order to be able to fill in the attributes present on it
Added the possibility to fill in attribute values in the headers of CSV/XLSX files. See Sheet2Xml -> Attribute value in tag
Files opened by the Xlsx2Csv command no longer appear as modified
Modification of the goal Xlsx2Csv with the use of an outputDirectory
Added a warning if Xlsx2Csv produces a file with the same name

Bug fix

Fix a bug when a test file contained too many tests (about 150), its execution ended with a StackOverflowError

4.2.2

Released on 2022-12-19

Bug fix

When the parameter Restapi.Integrationendpoints.Upload.Autoinvoke is set to false in the STEP server configuration, IIEPs are not automatically invoked after uploading a file. A parameter has been added to handle this case.

4.2.1

Released on 2022-05-31

Bug fix

Fixed the display of the Background Process result during a companion:deploy. It only displayed: [ERROR] Unsupported message type: Info

4.2.0

Released on 2022-05-23

Companion for Delivery release 4.2.0 offers supports of Java 17, remove support of Java 8 and add some other little improvements

New features

Java 17 supports

Companion for Delivery now supports Java 17 but is no longer compatible with Java 8

Json goal reports

The different goals generate a new json report that can be parsed to display readable messages. This feature has been developed in anticipation of the Companion for Business update

Decompiler list of value split

Decompiler has a new parameter that allows you to choose if lov are placed in several files : splitLov (true by default)

Improvements

The commented portal screens are now extracted correctly
Improved XML tag merge to ignore unnecessary spaces

Bug fix

Fixed decompilation of XSLT, the initial file generated could not be compiled
Fixed replacement of quotes other than " when running the xlsx2csv goal
Fixed Decompiler error message when there is no input or exportConfiguration set

4.1.1

Released on 2022-04-01

Bug fix

Fix bug on tag merging at compile. Tags with same attributes were incorrectly merged when using KeyValue instead of ID.
Fixed a bug where using a column comment would result in an empty tag and cause the XSD validation to fail.

4.1.0

Released on 2022-03-14

Companion for Delivery release 4.1.0 offers improvements for compiling and decompiling.

New features

Compiler ParentID sort

The compilation takes into account the values of the ID and ParentID attributes in order to sort the tags of the same type to avoid import dependency problems

Decompiler force XML

It is now possible to ask the decompiler to extract all elements in XML or SPLIT_XML format

Developer -> Decompiler

Keep Companion for Delivery up to date

Companion for Delivery now display a message when using a goal if a newer version is available. Check is done once a week

A newer version of Companion for Delivery is available : 4.1.0. See documentation https://companion.cantor.fr/c4d/changelog/companion-for-delivery.html

4.0.2

Released on 2022-03-11

Improvements

Merge all tags with same attributes and content at compile to remove duplicate tags.

Bug fix

Fix bug on tag merging at compile. Tags without ID were merged by mistake. These tags are no longer merged and the merge is now also done using the Key

4.0.1

Released on 2022-02-10

Bug fix

Fix compilation of inline references : <ref> were escaped
Fix MatchingAlgorithm decompilation to be in XML instead of CSV

4.0.0

Released on 2021-11-30

Companion for Delivery release 4.0.0 offers new license handling and reworked autocompletion system.

A new license is required to use versions higher than 4.0.0

New features

New license management system

New goals have been added to handle licenses: installation, activation, etc...

Companion for Delivery -> Project -> Maven goals -> License handling

Reworked autocompletion

The autocomplete system has been reworked to be compatible with other systems than IntelliJ like Visual Studio Code

Developer -> STEP API Autocomplete

Bug fix

Fixed an error when a file containing the companion:AssetBinaryContent tag contains empty values

3.7.0

Released on 2021-08-17

New features

Rest API V2 support for documentation from STEP

Step Rest API V2 support have been added to companion:documentation goal. Can only be used from STEP 10.0.

Devops -> Documentation -> Documentation from STEP

Decompile from STEP

exportConfiguration parameter have been added to goal companion:decompile to allow export and decompile from a Step environment.

Developer -> Decompiler

Improvements

Merge Product, Classification and AttributeLink tags at compile. Useful for replacement rule with STEPXML generated by Companion (See FAQ -> How to -> Replacement Rules).
Merge ListOfValue tags at compile. Useful to decompile ListOfValues files compiled by companion.

Bug fix

Fix Companion.LockOwner size from 100 to 1000. An issue occurred when lock owner id is greater than 100. As result as skipLock option was removed. If you use skipLock you should re-import following file companion-init.step.xml (See Companion for Delivery -> Installation -> Deployment)

3.6.3

Released on 2021-08-11

Bug fix

Fix javascript encoding in business rule decompiler
Fix missing escape when using predefined business rules
Add a warning for Icon file when decompiling two object types with the same ID case-insensitive
Fix paths in the JSDoc documentation to fill a markdown and its images

3.6.2

Released on 2021-05-10

Bug fix

Tests: handling of XML special characters inside parameter values of a business rule.

3.6.1

Released on 2021-04-09

Bug fix

Fix < and > error when deploying in STEP. To keep compatibility with existing files Companion escapes them following this behavior: < becomes <lt/> and > becomes <gt/> only if they are not used to import an html tag.

3.6.0

Released on 2021-02-26

Companion release 3.6.0 offers partial compilation feature and a new twirl extension.

New features

Partial compilation

New parameters have been added to goal companion:compile to allow to specify the perimeter of files to compile for each module.

csvRecords extensions

A new twirl extension has been added allowing to parse a csv file and transform it into a list of maps that can be used as variables in a .companion.xml file.

Developer -> Twirl -> Extensions -> csvRecords

3.5.2

Released on 2021-02-04

Improvements

Error management improved when calling the STEP REST API to avoid NullPointerException
Auto add an escape during STEPXML decompilation for special character @