Exporting and Importing Authoring Files
Cogynt Authoring includes data export and import functionality to enable sharing data between projects.
Exporting Data
In addition to exporting project components from individual views, Cogynt Authoring allows exporting complete projects and subsets of projects using the Export Manager utility. The utility exports this information as a .cef file (for entire projects) or .pcef file (for parts of projects), which can be archived, shared, and imported as needed.
Exporting Entire Projects
An entire Authoring project can be exported as a .cef file for archiving or importing. Projects can be exported from the Authoring main screen, and from within a project itself.
Exporting Projects from the Authoring Main Screen
To export an entire project from the Authoring main screen:
- In the Projects table, locate the project to deploy. For more information about navigating the table, see Navigating Available Projects.
- On the right of the project's row, click the More menu (⋮).
- Click Export Project. The project exports to your local machine as a .cef file.
Exporting Projects Within Projects Themselves
To export an entire project from within a project:
- On the application toolbar, click the drop-down menu to the right of the Close button.
- Click Export Project. The project exports to your local machine as a .cef file.
Exporting Partial Projects
Selected parts of an Authoring project can be exported as a .pcef file for archiving, importing, or distributing. Cogynt Authoring can export the following project components:
- Patterns
- Event Types
- Schemas
- Deployments
- Deployment Targets
- Lexicons
For more information about these components, see Model Artifacts.
Partial projects can be exported from the Authoring main screen, or from within projects themselves.
Exporting Partial Projects from the Authoring Main Screen
To export part of a project from the Authoring main screen:
- In the Projects table, locate the project to deploy. For more information about navigating the table, see Navigating Available Projects.
- On the right of the project's row, click the More menu (⋮).
- Click Export Components.
- In the Export Manager window:
- From the Package Types dropdown menu, select an artifact category. A checklist of corresponding project components appears.
- In the checklist, check the boxes of the components to export.
- In the Search bar, enter a word or several characters to look for specific components. The checklist updates automatically to show components matching the entered terms.
- From the Filter By dropdown list, select any tags to use as filters. In the Search bar, enter a word or several characters to look for specific tags. The list of tags updates automatically to show tags matching the entered terms.
- Click Export to export the project parts. (Note: The name of the button changes to reflect the type and quantity of components being exported. For example, it may say Export 35 Event Types.) The .pcef file is downloaded automatically. Alternatively, click Cancel to abandon the export.
Exporting Partial Projects Within Projects Themselves
To export part of a project from within a project:
- On the application toolbar, click the drop-down menu to the right of the Close button.
- Click Export Components.
- In the Export Manager window:
- From the Package Types dropdown menu, select an artifact category. A checklist of corresponding project components appears.
- In the checklist, check the boxes of the components to export.
- In the Search bar, enter a word or several characters to look for specific components. The checklist updates automatically to show components matching the entered terms.
- From the Filter By dropdown list, select any tags to use as filters. In the Search bar, enter a word or several characters to look for specific tags. The list of tags updates automatically to show tags matching the entered terms.
- Click Export to export the project parts. (Note: The name of the button changes to reflect the type and quantity of components being exported. For example, it may say Export 35 Event Types.) The .pcef file is downloaded automatically. Alternatively, click Cancel to abandon the export.
Single components can also be exported directly from their respective component management pages as follows:
- Locate the component to export by typing its name in the Search bar or by manually browsing the paginated list of components.
- In the component's table row, click the Export button.
Importing Data
Any file exported by Cogynt Authoring can be imported back into the system.
If the file was exported from an older version of Cogynt, it may contain outdated computations. Cogynt automatically migrates these computations to their newer alternatives after the imported data is opened. For more information, see Migrating Computations.
Importing Full Projects
A full project's .cef file can be imported into Cogynt to work with the project on another machine or in another Cogynt instance.
To import a full project:
- On the Authoring main screen, click the dropdown menu to the right of + New Project.
- Click Import Project.
- Locate the file to import on your local machine.
- Click Open to import the project, or click Cancel to abandon the import.
If the name of the project you are attempting to import matches the name of an existing project in the system, a warning dialog appears: A project named {NAME} already exists. This file will be imported as a copy. Would you like to import this file as a copy?
Click OK to import the file as a copy, or Cancel to abandon the import.
Copies are named {NAME}_{X}
, where {NAME}
is the name of the duplicate project, and {X}
is an integer.
Importing Partial Projects
A partial project's .pcef file can be imported into Cogynt to work with the exported components in another project, on another machine, or in another Cogynt instance.
Partial projects must be imported into an existing project.
To import a partial project in an opened project:
- On the application toolbar, click the drop-down menu to the right of the Close button.
- Click Import Components.
- Locate the file(s) to import on your local machine.
- Click Open to import the component files, or click Cancel to abandon the import.
If the name of a component you are attempting to import matches the name of an existing component in the system, a warning dialog appears: A {COMPONENT} named {NAME} already exists. This file will be imported as a copy. Would you like to import this file as a copy?
Click OK to import the file as a copy, or Cancel to abandon the import.
Copies are named {NAME}_{X}
, where {NAME}
is the name of the duplicate component, and {X}
is an integer.
Migrating Computations
Files exported from older versions of Cogynt may contain computations that are no longer supported in the current version. To fix this, Cogynt automatically migrates any outdated computations to their newer alternatives the first time the imported data is opened. This process only needs to be completed once.
Computation migration cannot be skipped.
To migrate computations:
- Import the full or partial project file.
- Open the project containing the imported data. The Migrating Computations window opens automatically.
- Wait until Cogynt Authoring finishes reviewing the data for outdated computations. The Migrating Computations window shows a preview of the processed data, and records a tally of any errors, warnings, or informational messages it generates.
- Once Authoring has processed the data:
- If no outdated computations or other errors were found, the imported data loads as normal. No migration is necessary, and no further action is required.
- If any outdated computations or other errors were found, Authoring generates a report documenting the problems it detected, and displays the report in the Migrating Computations window. Read the report, then click Download Report & Close. A copy of the report is downloaded to your local machine.
- On the right of the screen, click the Issues tab to display the components of the project that contain computations to migrate.
- For each affected component, do the following:
- Navigate to the component.
- In the upper-right of the screen, note the message:
Please verify migrated computations and then click Save
. - Review the computation changes in the component's diagram, modifying them as necessary. For more information about working with computations, see Outcome Computations Authoring.
- When finished, in the upper-right of the screen, click Save.
Any manual adjustments to the computation view are strictly visual. Existing deployments will still work without going through the verification and saving procedure.