Skip to content

Commit e09dccb

Browse files
Merge pull request #102 from ianf-mongodb/DOCSP-34504
DOCSP-34504 Add Atlas Login
2 parents 6aba161 + 7daccbb commit e09dccb

File tree

9 files changed

+46
-19
lines changed

9 files changed

+46
-19
lines changed

source/code-generation/query-converter/enable-query-converter.txt

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,14 @@ Enable Query Converter
1212

1313
You can use the query converter to convert SQL statements, views, and
1414
stored procedures to MongoDB syntax. The query converter considers the
15-
mapping rules and schema transformations defined in your project when converting
16-
your SQL code.
15+
mapping rules and schema transformations defined in your project when
16+
converting your SQL code.
17+
18+
Before You Begin
19+
----------------
20+
21+
Before you can use the query converter, you must sign in to your Atlas
22+
account in Relational Migrator. For details, see :ref:`rm-atlas-log-in`.
1723

1824
Steps
1925
-----
@@ -47,4 +53,4 @@ Next Steps
4753

4854
- :ref:`rm-convert-queries`
4955
- :ref:`rm-convert-views`
50-
- :ref:`rm-convert-stored-procedures`
56+
- :ref:`rm-convert-stored-procedures`

source/code-generation/query-converter/refresh-database-objects.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ Steps
5353
#. Click the :icon-fa5:`chevron-right` icon next to your schema.
5454

5555
#. Click the :icon-fa5:`chevron-right` icon next to
56-
:guilabel:`Stored Procedures` or :guilabel:`Views`.
56+
:guilabel:`Stored Procedures`, :guilabel:`Triggers`, or
57+
:guilabel:`Views`.
5758

5859
.. step:: Select the new database objects
5960

source/getting-started.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,5 @@ Steps
8181

8282
/getting-started/supported-databases
8383
/getting-started/migration-scenarios
84+
/getting-started/overview
85+
/getting-started/atlas-log-in

source/code-generation/query-converter/atlas-log-in.txt renamed to source/getting-started/atlas-log-in.txt

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Log In with Atlas
1010
:depth: 1
1111
:class: singlecol
1212

13-
You can sign in to your Atlas account inside Relational Migrator. When
14-
you log in with your Atlas account in Relational Migrator, you can
15-
access the :ref:`Query Converter <rm-query-converter>` feature.
13+
You can optionally sign in to your Atlas account inside Relational
14+
Migrator. If you log in, you can access the
15+
:ref:`Query Converter <rm-query-converter>` feature and you can choose
16+
destination clusters from a list when creating sync jobs.
1617

1718
Before you Begin
1819
----------------
1920

2021
To log in with Atlas, you must have an existing :atlas:`Atlas account
21-
</tutorial/create-atlas-account>` and a
22-
:atlas:`deployment </create-connect-deployments>`.
22+
</tutorial/create-atlas-account>`.
2323

2424
About this Task
2525
---------------
@@ -31,20 +31,38 @@ About this Task
3131
- ``8080``
3232
- ``443``
3333

34-
- If you run Relational Migrator on ports not listed above,
35-
the sign-in process fails.
34+
- If you run Relational Migrator on any ports numbers other than the
35+
ones listed above or if your accessing Relational Migrator from a
36+
remote client, you will not be able to sign in to Atlas.
3637

37-
- You might need to reauthenticate when your session token expires. To
38+
- You must reauthenticate when your session token expires. To
3839
reauthenticate to your Atlas account, follow the same log in procedure
3940
below.
4041

42+
- Depending on your Atlas login status the top-right profile section of
43+
the Relational Migrator UI can change:
44+
45+
.. list-table::
46+
:header-rows: 1
47+
48+
* - Login Status
49+
- Profile Section UI
50+
* - Signed Out
51+
- Section shows a :guilabel:`Log In` button.
52+
* - Logged In
53+
- The section shows a button with the first letter of the
54+
user's name.
55+
* - Session expired
56+
- The section shows a button with the first letter of the
57+
user's name with a :icon-fa5:`exclamation`.
58+
4159
Steps
4260
-----
4361

4462
.. procedure::
4563
:style: normal
4664

47-
.. step:: Select log in option
65+
.. step:: Select a login option
4866

4967
On the top right of the Relational Migrator home screen, click
5068
the profile icon or the :guilabel:`Log in` button. The account
@@ -78,4 +96,4 @@ Next Steps
7896
Learn More
7997
----------
8098

81-
- :atlas:`Create an Atlas Cluster </create-database-deployment/#clusters>`
99+
- :atlas:`Create an Atlas Cluster </create-database-deployment/#clusters>`

source/projects/overview.txt renamed to source/getting-started/overview.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,6 @@ UI Elements
4949
- View, edit, delete, and add mapping rules. Select and rename fields
5050
included in a mapping rule. Add and remove table filters.
5151

52-
* - Get Help Menu
52+
* - Get Help Menu / Atlas Login
5353
- .. include:: /includes/fact-get-help-menu.rst
5454

-142 KB
Loading
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
View links for documentation, support, community forums, and
22
product feedback. The menu also includes a
33
:guilabel:`Replay Product Tour` button to view the onscreen
4-
tutorial of the user interface.
4+
tutorial of the user interface. Use the :guilabel:`Login` button to
5+
set the credentials used to connect to your Atlas account.

source/mapping-rules/new-rules-from-relational.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ Steps
3737

3838
1. Open a project.
3939

40-
#. In the left :guilabel:`Schema model` pane, click on a collection under the
41-
:guilabel:`MongoDB` header.
40+
#. In the left :guilabel:`Schema model` pane, click on a collection under
41+
the :guilabel:`Relational` header.
4242

4343
This prompts the :guilabel:`Mappings` pane to open on the right of the screen.
4444

source/projects/projects.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ There are multiple options for you to create a project:
4343
/projects/create-project-live-connection
4444
/projects/create-project-loading-schema-files
4545
/projects/create-project-sample-schema
46-
/projects/overview
4746
/projects/configure-settings
4847
/projects/manage-relational-connection
4948
/projects/import-project

0 commit comments

Comments
 (0)