Skip to main content
Version: 6.19

CM/Archive

CM/Archive is a ConSol CM extension which allows to archive tickets from ConSol CM. It is a separate Java web application with a MongoDB database.

Installing and setting up the MongoDB database​

The first step is to install the MongoDB. You can find a detailed description in the respective MongoDB documentation for your operating system:

The next step is to configure the CM/Archive user with the corresponding authentication. Please proceed as follows:

  1. Start the MongoDB instance without authentication

    Use the following command to start the MongoDB instance without authentication:

     mongod --port 27017 --dbpath /data/archive

    The mongod options have the following meaning:

    • --port: Indicates the database connection port. The default value is 27017.
    • --dpath: Defines the directory where the MongoDB instance stores its data. The default value is /data/db on Linux and macOS, and \data\db on Windows.
    • --bind_ip: Use this option to provide the IP address if you want to change the default value (localhost, 127.0.0.1).

    Please see the mongod documentation for further information about the options.

  2. Connect to the MongoDB instance

    Use the following command to connect to the MongoDB instance:

     mongosh --host 127.0.0.1 --port 27017

    The following output should be displayed:

     Current Mongosh Log ID: 68c1661912c78da5cad861df
     Connecting to:          mongodb://127.0.0.1:27017/?directConnection=true&serverSelectionTimeoutMS=2000&appName=mongosh+2.5.0
     Using MongoDB:          8.0.13
     Using Mongosh:          2.5.0
     mongosh 2.5.7 is available for download: https://www.mongodb.com/try/download/shell
     
     For mongosh info see: https://www.mongodb.com/docs/mongodb-shell/
     
     test>

  3. Create the administrator user

    The administrator user has to be created in the admin database with the role userAdminAnyDatabase. The administrator user has only permissions to create and manage users and roles. It cannot be used for any other operations, e.g., reading data. The following command can be used to create the administrator user:

    use admin
    db.createUser(
      {
        user: "admin",
        pwd: passwordPrompt(),
        roles: [ { role: "userAdminAnyDatabase", db: "admin" } ]
      }
    )

  4. Restart the MongoDB instance with access control

    Disconnect the MongoDB shell and restart it with the --auth option or, if you use a configuration file, the security.authorization setting. The following command can be used to restart the MongoDB instance:

    mongod --auth --port 27017 --dbpath /data/archive

    Clients that connect to this instance must now authenticate themselves as a MongoDB user. They can only perform actions as determined by their assigned roles.

  5. Connect with the administrator user

    Use the following command to connect to the MongoDB instance with the above created administrator user:

    mongosh --host 127.0.0.1 --port 27017
    use admin
    db.auth("admin", passwordPrompt())

  6. Create the CM/Archive user

    Create the CM/Archive user archive with the database archivedb using the db.createUser() command. The user needs to have the readWrite role, as shown in the following example:

    use admin
    db.createUser(
      {
        user: "archive",
        pwd: passwordPrompt(),
        roles: [ { role: "readWrite", db: "archivedb" } ]
      }
    )

  7. Connect with the CM/Archive user

    Use the following command to connect to the MongoDB instance with the above created CM/Archive user:

    mongosh --host 127.0.0.1 --port 27017
    use admin
    db.auth("archive", passwordPrompt())
    use archivedb

Installing and setting up the CM/Archive application​

CM/Archive is a Spring boot application which can be executed as a standalone Java application. It relies on the authentication application for authentication.

You need to make the following settings in the archive-prod.properties files which needs to be saved in the same directory as the jar file of CM/Archive.

The following list states the meaning of the properties:

  • archive.mongodb.database.name: This is the name of the MongoDB database as created in step 6 above.
  • archive.mongodb.uri: Username and password of the CM/Archive user, and URL of the MongoDB instance
  • archive.oidc.client.id: Client ID of CM/Archive
  • archive.oidc.client.secret: Client secret of CM/Archive
  • archive.oidc.issuer: URL of the authentication application, e.g. https://CMAS_AUTH_USER_BACKEND/cmas-auth-user
  • archive.oidc.redirect.uri: OIDC endpoint of the CM/Archive URL, e.g. https://ARCHIVE_URL/oidc/
  • archive.oidc.state.ttl: Optional. Number of seconds while CM/Archive waits for a successful login by the OIDC provider. Default: 28800 (8 hours)
  • archive.oidc.global.logout: Optional. Determines if the user is also logged out from the OIDC provider when logging out of CM/Archive.

Example configuration:

archive.oidc.client.id=archive
archive.oidc.client.secret=94623427-5a74-11e8-a6eb-6127838b1c93
archive.oidc.issuer=https://CMAS_AUTH_USER_BACKEND/cmas-auth-user
archive.oidc.redirect.uri=https://ARCHIVE_URL/oidc/
archive.oidc.state.ttl=28800
archive.oidc.global.logout=true
archive.mongodb.database.name=archivedb
archive.mongodb.uri=mongodb://archive:consol@127.0.0.1:27017/?&journal=true&w=majority&maxPoolSize=1000

Setting the system properties for CM/Archive in the Web Admin Suite​

You need to make the following settings on the System properties page of the Web Admin Suite:

Module cmas-archive-core-server:

  • archive.uri: URL from which the CM/Archive application can be accessed.

Module cmas-core-security:

  • oidc.archive.accessTokenValidity.default: Determines the validity period in seconds of the access token required for using CM/Archive. The default value is 43200.
  • oidc.archive.clientId.default: Indicates the client ID (application ID) of the application, as registered with the OIDC provider; can be modified; must match archive.oidc.client.id in archive.properties
  • oidc.archive.clientSecret.default: Indicates the secret of the client; can be modified; must match archive.oidc.client.secret in archive.properties
  • oidc.archive.redirectUri.default: Indicates the redirect URI where authentication responses can be received; must match archive.oidc.redirect.uri in archive.properties
  • oidc.archive.refreshTokenValidity.default: Determines the validity period in seconds of the refresh token required for obtaining new access tokens for CM/Archive. The default value is 2592000.

Starting CM/Archive​

You can start CM/Archive using the following command:

java -jar cm-archive-$VERSION.jar --spring.profiles.active=prod

By default, CM/Archive starts on port 8080. You can choose a different port by adding, e.g., --server.port=8090 to the command.

Alternatively, you can create a start script for CM/Archive. Please contact the ConSol CM support for an example.