Giter Club home page Giter Club logo

itaa-docs's Introduction

itaa-docs

IBM IT Architect Assistant is a modeling and authoring tool designed to assist IT Architects to collaboratively create solution architectures. It currently is available as a hosted SasS offering on IBM Cloud and also available in a single-user Community Edition.

This repository provides the end-user documentation for each of these offerings. To get started, see:

  • Full collaborative IBM IT Architect Assistant
  • SIngle-User IBM IT Architect Assistant, Community Edition
    • What's new with v3.0 - Misc Diagrams that allow "sketching" as well as importing of Draw.io diagrams. Associated with this is the ability to render a Misc Diagram as an architecture diagram (you choose) and then be able to selectively convert drawing elements (annotations) to be architectural elements.

You can post issues to this repository for either offering of IBM IT Architect Assistant!

itaa-docs's People

Contributors

jsang16 avatar stevemar avatar zhyinjun avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

itaa-docs's Issues

Change order in Logical Connectors table

Usually the component model is forwarded to developers with the specification of the interfaces. A simple way of detailing the interfaces would be to have the Logical Connectors table ordered by "To Element". In this way, the developer would have all the logical connectors names (alias interfaces) of each component consolidated.

ITA Assistant Files not showing in offline workspace

Hi! I've done the setup correctly in a Windows 10 box and when I start the offline workspace in a chrome browser but the assets file (like business automations, icons, etc) which I downloaded, unzipped into workspace do not show. So I cannot use the tool!

How to depict cloud services in Physical Operational Model

In the POM you can define Prescribed, Virtual and Container Nodes but there is nothing equivalent to the physical description of a cloud service. For example if I want to describe a "Cloud Object Storage", I can define a "logical node" named "Object Storage" but there should be a "physical node" corresponding to it with a name that is defined in the IBM Cloud Resource List.

IBM Confidential footer in PPT

The powerpoint exports include "IBM Confidential" in the footer of the master layouts and the IBM logo seems to be shrinked in the headers.

“ca-offline-macos” cannot be opened

Hello, I suggest you include some guidelines or instructions for the “ca-offline-macos” cannot be opened because the developer cannot be verified. message.
I a using MACOS Catalina Version 10.15.6.
Regards.

Error: ENOENT: no such file or directory when adding an image

I included a png image to my use case basic flow and now I can't export to ppt. I get error:
{ Error: ENOENT: no such file or directory, open 'workspace/..//workspace/Wallet/offline-images/file_7f1c68ba1737b577.png'
at Object.fs.openSync (fs.js:646:18)
at Object.fs.openSync (pkg/prelude/bootstrap.js:490:32)
at Object.fs.readFileSync (fs.js:551:33)
at Object.fs.readFileSync (pkg/prelude/bootstrap.js:686:36)
at Object.fn (/snapshot/CA-APP/offline_server.js:852:17)
at Router.handleRequest (/snapshot/CA-APP/node_modules/routes-router/index.js:157:19)
at emitTwo (events.js:126:13)
at Server.emit (events.js:214:7)
at parserOnIncoming (_http_server.js:660:12)
at HTTPParser.parserOnHeadersComplete (_http_common.js:119:17)
errno: -2,
code: 'ENOENT',
syscall: 'open',
path: 'workspace/..//workspace/Wallet/offline-images/file_7f1c68ba1737b577.png' }

As you can see from the last sentence, it seems to be an error with concatenating the directoy name.
Regards.
Carlos

Can not run the assistant on macbook pro with error "./ca-offline-macos: Bad CPU type in executable"

I followed the instructions to install the assistant code. I am installing it on MacBook Pro.
When I run the run.sh I get the following error:
Using CATALINA_BASE: /Users/zoro/DevLab/IBM/cogarch/Community-Edition-3.17.0/CAAppOffline/tomcat Using CATALINA_HOME: /Users/zoro/DevLab/IBM/cogarch/Community-Edition-3.17.0/CAAppOffline/tomcat Using CATALINA_TMPDIR: /Users/zoro/DevLab/IBM/cogarch/Community-Edition-3.17.0/CAAppOffline/tomcat/temp Using JRE_HOME: ../jre/Contents/Home Using CLASSPATH: /Users/zoro/DevLab/IBM/cogarch/Community-Edition-3.17.0/CAAppOffline/tomcat/bin/bootstrap.jar:/Users/zoro/DevLab/IBM/cogarch/Community-Edition-3.17.0/CAAppOffline/tomcat/bin/tomcat-juli.jar Using CATALINA_OPTS: Tomcat started. ./run.sh: line 11: ./ca-offline-macos: Bad CPU type in executable

I tried to run the command
xattr -cr ./ca-offline-macos

But the issue still exists and I can not start the server.

When I checked the logs folder I found the catalina.out file which includes the following line:

/Users/zoro/DevLab/IBM/cogarch/Community-Edition-3.17.0/CAAppOffline/tomcat/bin/catalina.sh: line 504: ../jre/Contents/Home/bin/java: Bad CPU type in executable

Here is the information of my system

Hardware Overview:

Model Name: MacBook Pro
Model Identifier: MacBookPro17,1
Chip: Apple M1
Total Number of Cores: 8 (4 performance and 4 efficiency)
Memory: 16 GB
System Firmware Version: 7429.81.3
OS Loader Version: 7429.81.3

System Software Overview:

System Version: macOS 12.2.1 (21D62)
Kernel Version: Darwin 21.3.0

Export icon not visible in lasta version of Google Chrome

All the icons from change log, export, copy and information are not visible. This seems to happen since a new refresh from Google Chrome.
Captura de pantalla 2023-07-24 a la(s) 15 29 04
Captura de pantalla 2023-07-24 a la(s) 15 29 19
In the attached screenshots you can see the difference between Chrome and Safari. As you can see from the first screen, I was able to hover over the export location and was able to enable the export panel. I suppose this has something to do with default colors in the new Chrome. I am using Chrome Versión 114.0.5735.198 (Build oficial) (x86_64)

Latest version of Community Edition?

How can we know that we are at the latest version of Community Edition? The web interface on my local displays v3.0 but on GitHub I can see there are tags that are 3.7. If we can update what should be the procedure?
Thanks!

Unable to export images

Hello, I haven't used Cognitive Architect for a while but now when I try to export a file I get an error message when exporting to ppt and in the case of word format I get the text but not the included images. I am including the log and har files of the run.
CAA.log
CAA.har.zip
Any idea what I am missing?
I am using the latest version: Version V3.2.2
Regards.

Component Model - Dynamic View line position not respecte in .doc file

The real position of a "self call" message is not respected in the word and ppt version of the architecture. By the way, practice is not enough to position the message lines especially when during the definition of the flow you decide to add a message in the middle... which is something common during the elavoration of the architecture.
Here a screenshot the the Dynamic View:
CA version
Here the output of the word export: Word version
Here the powerpoint version:
PPT version

How do you integrate into current Dev streams

Considering that the documentation generated with this tool is considered System Documentation and in Agile it is recommended that it be included in the same versioning tool as the code .... is there some type of How-To to join ITAA with these tools, like Github?

copy/paste name conflict popup doesn't appear

Hello ,the User Guide states that copy/paste should detect name conflicts but it directly creates duplicate entries with "copy of". Please can you confirm that this feature is available in community edition or what a I doing wrong?
By the way, the export/import also speaks about importing from excel but later the import doesn't give more detail about that. I suppose you forgot to delete also this feature from the doc.
Thanks in advance
Carlos

Unable to download ppt, doc file - http://localhost:3300 express deprecated res.send(status): Use res.sendStatus(status) instead ../../../../../../snapshot/CA-APP/offline_server.js:36:36 { Error: connect ECONNREFUSED 127.0.0.1:3302

Hi,
I have set up the tomcat & a JDK version, run the tool. created a project. updated few details then tried to download the word document given me below error: Please verify and provide details. thanks
kishore@KISHOREs-MacBook-Pro CAAppOffline % ./install.sh
Please keep this window open until the installation is completed. If any error appears, please rerun the script.
Input tomcat-8.5 folder path(e.g. ~/Desktop/apache-tomcat-8.5.45), then click Enter: /Users/kishore/Documents/IBM/Architectures/CAAppOffline/apache-tomcat-8.5.78
Input jre folder path(e.g. ~/Desktop/jre1.8.0_131.jre), then click Enter: /Users/kishore/Documents/IBM/Architectures/CAAppOffline/jdk-18.jdk
Installed the application successfully. You can input "./run.sh" to run the application.
kishore@KISHOREs-MacBook-Pro CAAppOffline % ./run.sh
Using CATALINA_BASE: /Users/kishore/Documents/IBM/Architectures/CAAppOffline/apache-tomcat-8.5.78
Using CATALINA_HOME: /Users/kishore/Documents/IBM/Architectures/CAAppOffline/apache-tomcat-8.5.78
Using CATALINA_TMPDIR: /Users/kishore/Documents/IBM/Architectures/CAAppOffline/apache-tomcat-8.5.78/temp
Using JRE_HOME: /usr/local/opt/openjdk@8
Using CLASSPATH: /Users/kishore/Documents/IBM/Architectures/CAAppOffline/apache-tomcat-8.5.78/bin/bootstrap.jar:/Users/kishore/Documents/IBM/Architectures/CAAppOffline/apache-tomcat-8.5.78/bin/tomcat-juli.jar
Using CATALINA_OPTS:
Tomcat started.
Listening on 0.0.0.0, port 3300
Open the offline App by copying and pasting the link below into the address bar of your web browser.

http://localhost:3300
express deprecated res.send(status): Use res.sendStatus(status) instead ../../../../../../snapshot/CA-APP/offline_server.js:36:36
{ Error: connect ECONNREFUSED 127.0.0.1:3302
at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1191:14)
errno: 'ECONNREFUSED',
code: 'ECONNREFUSED',
syscall: 'connect',
address: '127.0.0.1',
port: 3302 }
Error: connect ECONNREFUSED 127.0.0.1:3302
at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1191:14)
{ Error: socket hang up
at createHangUpError (_http_client.js:342:15)
at Socket.socketCloseListener (_http_client.js:377:23)
at emitOne (events.js:121:20)
at Socket.emit (events.js:211:7)
at TCP._handle.close [as _onclose] (net.js:561:12) code: 'ECONNRESET' }
Error: socket hang up
at createHangUpError (_http_client.js:342:15)
at Socket.socketCloseListener (_http_client.js:377:23)
at emitOne (events.js:121:20)
at Socket.emit (events.js:211:7)
at TCP._handle.close [as _onclose] (net.js:561:12)
{ Error: connect ECONNREFUSED 127.0.0.1:3302
at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1191:14)
errno: 'ECONNREFUSED',
code: 'ECONNREFUSED',
syscall: 'connect',
address: '127.0.0.1',
port: 3302 }
Error: connect ECONNREFUSED 127.0.0.1:3302
at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1191:14)
{ Error: socket hang up
at createHangUpError (_http_client.js:342:15)
at Socket.socketCloseListener (_http_client.js:377:23)
at emitOne (events.js:121:20)
at Socket.emit (events.js:211:7)
at TCP._handle.close [as _onclose] (net.js:561:12) code: 'ECONNRESET' }
Error: socket hang up
at createHangUpError (_http_client.js:342:15)
at Socket.socketCloseListener (_http_client.js:377:23)
at emitOne (events.js:121:20)
at Socket.emit (events.js:211:7)
at TCP._handle.close [as _onclose] (net.js:561:12)

Error: listen EADDRINUSE :::3301 while starting ITAA Community edition on MAC osx

getting an error while starting ITAA on mc osx
Tomcat 8.5.61
openjdk-15.0.1
Mac osx 11.1

Using CATALINA_BASE: /Users/rh42/Architektur/CAApp/CAAppOffline/tomcat
Using CATALINA_HOME: /Users/rh42/Architektur/CAApp/CAAppOffline/tomcat
Using CATALINA_TMPDIR: /Users/rh42/Architektur/CAApp/CAAppOffline/tomcat/temp
Using JRE_HOME: ../jre/Contents/Home
Using CLASSPATH: /Users/rh42/Architektur/CAApp/CAAppOffline/tomcat/bin/bootstrap.jar:/Users/rh42/Architektur/CAApp/CAAppOffline/tomcat/bin/tomcat-juli.jar
Using CATALINA_OPTS:
Tomcat started.
{ Error: listen EADDRINUSE :::3301
at Server.setupListenHandle [as _listen2] (net.js:1360:14)
at listenInCluster (net.js:1401:12)
at Server.listen (net.js:1485:7)
at Function.listen (/snapshot/CA-APP/node_modules/express/lib/application.js:618:24)
at Object. (/snapshot/CA-APP/offline_server.js:704:5)
at Module._compile (pkg/prelude/bootstrap.js:1261:22)
at Object.Module._extensions..js (module.js:662:10)
at Module.load (module.js:564:32)
at tryModuleLoad (module.js:504:12)
at Function.Module._load (module.js:496:3)
at Function.Module.runMain (pkg/prelude/bootstrap.js:1316:12)
at startup (bootstrap_node.js:240:16)
at bootstrap_node.js:661:3
errno: 'EADDRINUSE',
code: 'EADDRINUSE',
syscall: 'listen',
address: '::',
port: 3301 }
Error: listen EADDRINUSE :::3301
at Server.setupListenHandle [as _listen2] (net.js:1360:14)
at listenInCluster (net.js:1401:12)
at Server.listen (net.js:1485:7)
at Function.listen (/snapshot/CA-APP/node_modules/express/lib/application.js:618:24)
at Object. (/snapshot/CA-APP/offline_server.js:704:5)
at Module._compile (pkg/prelude/bootstrap.js:1261:22)
at Object.Module._extensions..js (module.js:662:10)
at Module.load (module.js:564:32)
at tryModuleLoad (module.js:504:12)
at Function.Module._load (module.js:496:3)
at Function.Module.runMain (pkg/prelude/bootstrap.js:1316:12)
at startup (bootstrap_node.js:240:16)
at bootstrap_node.js:661:3
{ Error: listen EADDRINUSE 0.0.0.0:3300
at Server.setupListenHandle [as _listen2] (net.js:1360:14)
at listenInCluster (net.js:1401:12)
at doListen (net.js:1510:7)
at _combinedTickCallback (internal/process/next_tick.js:142:11)
at process._tickCallback (internal/process/next_tick.js:181:9)
errno: 'EADDRINUSE',
code: 'EADDRINUSE',
syscall: 'listen',
address: '0.0.0.0',
port: 3300 }
Error: listen EADDRINUSE 0.0.0.0:3300
at Server.setupListenHandle [as _listen2] (net.js:1360:14)
at listenInCluster (net.js:1401:12)
at doListen (net.js:1510:7)
at _combinedTickCallback (internal/process/next_tick.js:142:11)
at process._tickCallback (internal/process/next_tick.js:181:9)
Rolands-MBP:CAAppOffline rh42$ ./run.sh
Using CATALINA_BASE: /Users/rh42/Architektur/CAApp/CAAppOffline/tomcat
Using CATALINA_HOME: /Users/rh42/Architektur/CAApp/CAAppOffline/tomcat
Using CATALINA_TMPDIR: /Users/rh42/Architektur/CAApp/CAAppOffline/tomcat/temp
Using JRE_HOME: ../jre/Contents/Home
Using CLASSPATH: /Users/rh42/Architektur/CAApp/CAAppOffline/tomcat/bin/bootstrap.jar:/Users/rh42/Architektur/CAApp/CAAppOffline/tomcat/bin/tomcat-juli.jar
Using CATALINA_OPTS:
Tomcat started.
{ Error: listen EADDRINUSE :::3301
at Server.setupListenHandle [as _listen2] (net.js:1360:14)
at listenInCluster (net.js:1401:12)
at Server.listen (net.js:1485:7)
at Function.listen (/snapshot/CA-APP/node_modules/express/lib/application.js:618:24)
at Object. (/snapshot/CA-APP/offline_server.js:704:5)
at Module._compile (pkg/prelude/bootstrap.js:1261:22)
at Object.Module._extensions..js (module.js:662:10)
at Module.load (module.js:564:32)
at tryModuleLoad (module.js:504:12)
at Function.Module._load (module.js:496:3)
at Function.Module.runMain (pkg/prelude/bootstrap.js:1316:12)
at startup (bootstrap_node.js:240:16)
at bootstrap_node.js:661:3
errno: 'EADDRINUSE',
code: 'EADDRINUSE',
syscall: 'listen',
address: '::',
port: 3301 }
Error: listen EADDRINUSE :::3301
at Server.setupListenHandle [as _listen2] (net.js:1360:14)
at listenInCluster (net.js:1401:12)
at Server.listen (net.js:1485:7)
at Function.listen (/snapshot/CA-APP/node_modules/express/lib/application.js:618:24)
at Object. (/snapshot/CA-APP/offline_server.js:704:5)
at Module._compile (pkg/prelude/bootstrap.js:1261:22)
at Object.Module._extensions..js (module.js:662:10)
at Module.load (module.js:564:32)
at tryModuleLoad (module.js:504:12)
at Function.Module._load (module.js:496:3)
at Function.Module.runMain (pkg/prelude/bootstrap.js:1316:12)
at startup (bootstrap_node.js:240:16)
at bootstrap_node.js:661:3
{ Error: listen EADDRINUSE 0.0.0.0:3300
at Server.setupListenHandle [as _listen2] (net.js:1360:14)
at listenInCluster (net.js:1401:12)
at doListen (net.js:1510:7)
at _combinedTickCallback (internal/process/next_tick.js:142:11)
at process._tickCallback (internal/process/next_tick.js:181:9)
errno: 'EADDRINUSE',
code: 'EADDRINUSE',
syscall: 'listen',
address: '0.0.0.0',
port: 3300 }
Error: listen EADDRINUSE 0.0.0.0:3300
at Server.setupListenHandle [as _listen2] (net.js:1360:14)
at listenInCluster (net.js:1401:12)
at doListen (net.js:1510:7)
at _combinedTickCallback (internal/process/next_tick.js:142:11)
at process._tickCallback (internal/process/next_tick.js:181:9

Use case "sort by"

The Use case artifact should remember the last "sort by" defined. Each time I enter a use case description and go back to the list, the order of the use cases return to creation date. This is not critical but annoying.

No Linux client

Can you provide a linux client install script?
Also, perhaps use the IBM JRE/JDK?

Copyright message in PPT

The ppowerpoint templates include an IBM copyright message. The options, a) if it must be legaly included, change to a more current date. It states 2017 and ITAA was released in 2019. b) if we consdier that the architecture is owned by the user, this should be deleted.

Cannot create new workspace

MACOS v11.4
Tried to create a workspace , but got error message in terminal.

Error: ENOENT: no such file or directory, mkdir 'workspace/jump' at Object.fs.mkdirSync (fs.js:885:18) at CommonAssist.mkdir (/snapshot/CA-APP/offline_server.js:155:8) at /snapshot/CA-APP/offline_server.js:330:16 at Layer.handle [as handle_request] (/snapshot/CA-APP/node_modules/express/lib/router/layer.js:95:5) at next (/snapshot/CA-APP/node_modules/express/lib/router/route.js:137:13) at jsonParser (/snapshot/CA-APP/node_modules/body-parser/lib/types/json.js:101:7) at Layer.handle [as handle_request] (/snapshot/CA-APP/node_modules/express/lib/router/layer.js:95:5) at next (/snapshot/CA-APP/node_modules/express/lib/router/route.js:137:13) at Route.dispatch (/snapshot/CA-APP/node_modules/express/lib/router/route.js:112:3) at Layer.handle [as handle_request] (/snapshot/CA-APP/node_modules/express/lib/router/layer.js:95:5)

Error: ENOENT: no such file or directory, scandir 'workspace/' at Object.fs.readdirSync (fs.js:904:18) at Object.fs.readdirSync (pkg/prelude/bootstrap.js:787:35) at readDirList (/snapshot/CA-APP/offline_server.js:233:18) at Object.getRootList (/snapshot/CA-APP/offline_server.js:270:5) at CommonAssist.loadAllFromRootList (/snapshot/CA-APP/offline_server.js:101:26) at /snapshot/CA-APP/offline_server.js:282:16 at Layer.handle [as handle_request] (/snapshot/CA-APP/node_modules/express/lib/router/layer.js:95:5) at next (/snapshot/CA-APP/node_modules/express/lib/router/route.js:137:13) at Route.dispatch (/snapshot/CA-APP/node_modules/express/lib/router/route.js:112:3) at Layer.handle [as handle_request] (/snapshot/CA-APP/node_modules/express/lib/router/layer.js:95:5)

Source/package not available

It's said in the Install.md for CE :
Currently, the community edition is provided via a zip file in Github for downloading. After downloading, unzipping and installing, you can use it on your local system.

Problem : no package on github to download.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.