Service description - Admin Console

March 4, 2024|Nataliia Berdychevska

[A]Admin Console

1Login to the Admin Console

1.1Add "admin" in the link after the indicated domain of SMASHDOCs system

1.2Insert required provisioning key

2Quick Format Buttons

2.1Create quick format buttons

(a)Configuration

(i)Name

(ii)Samples

(iii)PD Group

(iv)Show everywhere

(1)On

(2)Off

(v)Icon

2.2Search style or template

2.3Move style

2.4Edit style

2.5Upload a JSON file with quick start menus

2.6Download a JSON file with quick start menus

2.7Select style

2.8Delete style

3Component Tags

3.1Create a new component tag

(a)Configuration

(i)Tag key

(ii)Сomponent types

(1)Text

(2)Table

(3)Image

(4)Formula

(iii)Display key

(iv)Allowed PDs

(v)Unique

(1)Yes

(2)No

(vi)Text colour

(vii)Filling colour

(viii)Name in all supported languages

(ix)Field key

(1)Name in all supported languages

(x)Value

(1)Name of value

(2)Edit value

(3)Delete value

3.2Edit component tag

3.3Upload a JSON file with component tags

3.4Download a JSON file with component tags

3.5Select component tag

3.6Delete components tag

4Special Characters

4.1Create special characters menu

(a)Configuration

(i)Key

(ii)Name in all supported languages

(iii)Add a new character

(1)Add special character code

(2)Delete special character code

(3)Add special character name

(4)Add next special character

4.2Edit special character

4.3Upload a JSON file with special characters

4.4Download a JSON file with special characters

4.5Select special character

4.6Delete special character

5Inline Styles

5.1Create a new style

(a)Configuration

(i)Key

(ii)Name in all supported languages

(iii)Font colour

(iv)Font size

(v)Text shadow

(vi)Font weight

(vii)Text decoration

(viii)Background colour

(ix)Font family

(x)Font style

(xi)Text transform

(xii)Shortcut

(xiii)Advanced settings

5.2Edit inline style

5.3Select inline style

5.4Delete inline style

6Paragraph Decorators

6.1Add new paragraph decorator

(a)Decorator's name

(i)Key

(ii)Сomponent types

(1)Text

(2)Table

(3)Image

(iii)Group

(iv)Active

(1)On

(2)Off

(v)Name in all supported languages

(b)Positioning

(i)Indentation level

(ii)Fixed indentation

(1)On

(2)Off

(iii)Backspace

(1)At the beginning of a component with content

(A)Merge

(B)Apply another paragraph decorator

(C)Remove PD

(D)Nothing

(iv)Return

(1)Style of next component

(A)Apply another paragraph decorator

(B)Nothing

(2)PD for current component on return if empty

(A)Apply another paragraph decorator

(B)Nothing

(3)PD for new component on return if empty

(A)Apply another paragraph decorator

(B)Nothing

(v)TAB / SHIFT+TAB

(1)TAB – change current style to another selected style

(A)Apply another paragraph decorator

(B)Nothing

(2)SHIFT+TAB – change current style to another selected style

(A)Apply another paragraph decorator

(B)Nothing

(c)List

(i)Decide whether it is a list (yes/no)

(ii)If "Yes":

(1)List name

(2)Order level

(3)Suffix distance

(4)Magic tabs (yes/no)

(5)Type of list (Unordered/Ordered)

(iii)Unordered type of list:

(1)List item

(iv)Ordered type of list:

(1)Numbering style

(2)Continue numbering after interruption (on/off)

(3)Allow restart numbering (on/off)

(4)Show numbering from indicated level

(5)Advanced list pattern settings - on:

(A)Ordered list pattern

(B)XRefs list pattern

(C)Numbering placeholders (key, name in all supported languages)

(D)Soft return (on/off)

(E)Side number (on/off)

(6)Advanced list pattern settings - off:

(A)Prefix

(B)Suffix

(C)XRefs list pattern

(D)Numbering placeholders (key, name in all supported languages)

(E)Soft return (on/off)

(F)Side number (on/off)

(d)Referencing

(i)Reference group

(1)None

(2)Reference group created in the system

(ii)Create new reference group

(1)Configuration

(A)Key

(B)Name in all supported languages

(e)Typography

(i)Font

(ii)Alignment

(iii)Font size

(iv)Font colour

(v)Read only

(1)On

(2)Off

(vi)Stylings

(1)Bold

(2)Italic

(3)Underlined

(4)Stroke

(vii)Text transform

(1)None

(2)Uppercase

(3)Lowercase

(4)Small caps

(f)Distances

(i)Merge components

(1)On

(2)Off

(ii)Margin top

(iii)Margin bottom

(iv)1st row indent

(v)Other rows indents

(vi)Line spacing

(vii)Word spacing

(g)Frames

(i)Top

(ii)Bottom

(iii)Left

(iv)Right

(v)Frame colour

(vi)Frame thickness

(vii)Type of frame

(viii)Merge components

(1)On

(2)Off

(h)Filling

(i)Filling colour

(ii)Merge components

(1)On

(2)Off

(i)ToC

(i)ToC indentation

(j)Short cuts

(i)Mac

(ii)Windows

6.2Reset - delete all decorators, inlines, XRef and QuickStart Menus

6.3Select all or several items

6.4Upload a JSON file with decorators

(a)with decorators groups

(b)without decorators groups

6.5Download a JSON file with decorators

(a)with decorators groups

(b)without decorators groups

6.6Bulk edit

6.7Show hidden paragraph decorators

6.8Show default paragraph decorators

6.9Edit paragraph decorator

6.10Active paragraph decorator

(a)On

(b)Off

6.11Duplicate paragraph decorator

6.12Delete paragraph decorator

7XRefs Groups

7.1Create a new XRef group

(a)Configuration

(i)Group key

(ii)Name in all supported languages

7.2Upload a JSON file with XRefs groups

7.3Download a JSON file with XRefs groups

7.4Edit XRefs group

7.5Select XRef group

7.6Delete XRef group

8Import Settings

8.1Add new document for import

(a)drag and drop

(b)select from the device

8.2Select paragraph styles

8.3Select levels for paragraph styles

8.4Upload a JSON file with import settings

8.5Download a JSON file with import settings

8.6Delete all import settings

9Magic Import

9.1Add magic import configuration

(a)Upload JSON file with configuration

(b)Cancel the process

9.2Check styles for mapping

9.3Add new styles for mapping

(a)Insert key

(b)Insert mapping

(c)Cancel the process

9.4Download JSON file with configuration

10Sample Documents

10.1Create a new sample document

(a)Insert name

(b)Upload a file in .sdox format

(i)drag and drop

(ii)select from the device

10.2Edit sample document

10.3Download sample document

10.4Select sample document

10.5Delete sample document

11Workflows

11.1Create new workflow

11.2Edit workflow

11.3Delete workflow

11.4Add new theme

11.5Edit theme

(a)Names

(b)General settings

(i)Margins

(1)Top

(2)Right (outer)

(3)Bottom

(4)Left (outer)

(ii)Indentational levels (Level 1 - Level 6)

(iii)Others

(1)Page orientation

(A)Portrait

(B)Landscape

(2)Page height

(3)Page width

(4)Double page

(A)Yes

(B)No

(5)Font size

(c)ParStyles

(i)Add paragraph styles

(ii)Edit paragraph styles

(1)ToC Level

(2)Font Size

(3)Font Color

(4)Frame Color Top

(5)Frame Color Right

(6)Frame Color Bottom

(7)Frame Color Left

(8)Line Space

(9)Frame Thickness Top

(10)Frame Thickness Right

(11)Frame Thickness Bottom

(12)Frame Thickness Left

(13)Hyphenation

(14)Bold

(15)Italic

(16)Underlined

(17)Strike-through

(18)Alignment

(A)Left

(B)Centered

(C)Right

(19)Do not separate lines

(20)Do not separate from next element

(21)Margin Bottom for Same Previous Paragraph

(22)Margin Top for Same Previous Paragraph

(iii)Delete paragraph styles

(1)Delete all styles

(2)Delete selected styles

(d)DirectoryStyles

(i)Add directory styles

(ii)Edit directory styles

(1)ToC Level

(2)Font Size

(3)Font Color

(4)Line Space

(5)Hyphenation

(6)Bold

(7)Italic

(8)Underlined

(9)Strike-through

(10)Alignment

(A)Left

(B)Centered

(C)Right

(11)Do not separate lines

(12)Do not separate from next element

(13)Margin Bottom for Same Previous Paragraph

(14)Margin Top for Same Previous Paragraph

(iii)Delete directory styles

(1)Delete all styles

(2)Delete selected styles

(e)Container

(i)Add containers

(ii)Edit containers

(1)Margin Top

(2)Margin right

(3)Margin bottom

(4)Margin left

(iii)Replicate containers

(iv)Delete containers

11.6Delete theme

11.7Replicate theme

11.8Publish to Live

11.9Change to Sandbox

12SDOX Templates

12.1Create a new template

(a)Select file

(b)Insert template name

12.2Download templates

12.3Replicate templates

12.4Edit templates

(a)Edit name in all supported languages

(b)Edit paragraph styles

(i)Activate paragraph styles

(ii)Deactivate paragraph styles

(iii)Search style

(iv)Activate fallback

(v)Deactivate fallback

(vi)Switch forwards to the further list of rows with paragraph styles

(vii)Switch backwards to the previous list of rows with paragraph styles

(viii)Show:

(1)all styles

(2)active styles

(3)inactive styles

(c)Edit inline styles

(i)Activate inline styles

(ii)Deactivate inline styles

(iii)Search style

(iv)Show:

(1)all styles

(2)active styles

(3)inactive styles

(d)Edit export

(i)Activate export formats

(ii)Deactivate export formats

(iii)Activate layouts

(iv)Deactivate layouts

12.5Delete templates

13SmartDocuments

13.1Available if the module "SmartDocuments Interview" is activated in the system

13.2Create new template

(a)Insert metadata

(i)Name

(ii)SD name

(iii)Review mode

(1)On

(2)Off

13.3Search style or template

13.4Upload a JSON file with templates

13.5Download a JSON file with templates

13.6Select templates

13.7Delete templates

14Export Templates

14.1Formats

(a)ePub

(b)InDesign

(c)PDF

(d)Switch on formats for their templates to be displayed in the list

(e)Switch off formats for their templates not to be displayed in the list

14.2Add new template

(a)Metadata:

(i)Name

(ii)Type

(iii)SDOX version (optionally)

(iv)Pipeline name

(v)Host

(vi)Login

(vii)Password

14.3Edit templates

14.4Upload JSON file with templates

14.5Download JSON file with templates

14.6Move templates

14.7Delete templates

15Word Templates

15.1Create new word templates

(a)Add ten placeholders to Word file with a template for SMASHDOCs system to accept all styles from the template

(b)Upload DOCX or DOCM file with a template into Admin Console

(i)drag and drop

(ii)select file from the device

(c)Insert template name

(d)Cancel the process

15.2Edit templates

(a)Edit displayed export name

(b)Upload Word template

(c)Download Word template

(d)Paragraph styles

(i)Edit Word mapping

(e)Inline styles

(i)Edit Word mapping

(f)Link styles

(i)Edit Word mapping

(g)Grid (Level 0 - Level 5)

(i)Change levels

15.3Delete templates

15.4Download templates

15.5Replicate templates

16ParsX Mapping

16.1Upload a JSON file with ParsX mapping

16.2Download a JSON file with ParsX mapping

16.3Reset settings

17Hyphenation Dictionary

17.1Upload a .txt-file with hyphenation dictionary

(a)Select a file from the computer

(b)Drag&drop a file

(c)Cancel the process

17.2Download a JSON-file with hyphenation dictionary

17.3Reset settings

18Division separators

18.1Add division separator template

(a)Insert name

(b)Insert ID

(c)Set template as active

(d)Set template as inactive

(e)Set page numbering

(i)Add prefix

(ii)Select format

(iii)Add suffix

(iv)Restart numbering

(v)Continue numbering

(vi)Select alignment

(1)left

(2)centered

(3)right

(f)Show preview

(g)Cancel the process

18.2Edit division separator template

18.3Activate division separator template

18.4Deactivate division separator template

18.5Delete division separator template

18.6Add preset list

(a)Set the name

(b)Set ID

(c)Set preset list as active

(d)Set preset list as inactive

(e)Add templates to the preset list

(f)Cancel the process

18.7Edit preset list

18.8Activate preset list

18.9Deactivate preset list

18.10Delete preset list

19Features

19.1Features toggles and limitations:

(a)Authentication

(i)OAuth2 server

(ii)OpenID auth

(iii)Platform SSO

(b)Login page

(i)Login page

(ii)User registration

(iii)Captcha

(iv)Welcome email

(c)Document user management

(i)Editor role

(ii)Invitation dialogue - show company to user

(iii)Invitation dialogue - show user e-mail address

(iv)User management - visible in document

(v)Deselect section history

(vi)Deselect invite user

(d)Document creation

(i)Allow document creation for external users

(ii)Control ability to duplicate a document per user

(iii)Import - MS Word. docx

(iv)Create new blank document

(v)Import - MS Word .docx + recognize transkript

(vi)Import - SDOX

(vii)Create document from SDOX template

(viii)Magic import

(ix)Magic import IPO

(x)Convert captions weblinks href to simple text

(e)Editor in general

(i)Component link

(ii)Inline styles - navigation

(iii)Document metadata - edit

(iv)Move segments

(v)Allow share to review

(f)Editor tables

(i)Table column sorting

(ii)Table width = 100% only

(iii)Excel 365 connected tables

(iv)SpreadJS formula tables

(v)Excel roundtrip per table

(vi)Excel roundtrip for all tables

(vii)Layout table

(g)Editor top toolbar

(i)Alignment

(ii)Indent outdent

(h)Export

(i)CloudConvert - PDF

(ii)HTML export

(iii)HTML Report - All-In-One Report

(iv)Images

(v)Pagina - XML

(vi)Export PDF Pagina Media

(vii)Export SDXML

(viii)SRZ - PDF

(ix)SRZ - XML

(x)SRZ - InDesign

(xi)WORD .docx

(xii)ePUB

(xiii)Paginamedia PDF-/A/UA/EPUB

(xiv)Export PDF via publishing API

(i)Inline styles (Standard)

(i)Bold

(ii)Italic

(iii)Smallcaps

(iv)Strikethrough

(v)Underlined

(vi)Subscript

(vii)Superscript

(viii)Transcript

(j)Modules & Inline objects

(i)Announcement

(ii)Bibliography

(iii)Document comparison, Roundtrip

(iv)Dashboard homepage

(v)Equations

(vi)Index

(vii)Inline files

(viii)Inline images

(ix)Inline checkbox

(x)Projects

(xi)Side notes

(xii)Signaturit

(xiii)SmartDocuments

(xiv)Versions

(xv)Special characters

(xvi)Spellcheck

(xvii)Division separators

(k)System limitations

(i)Users per doc limit

19.2Search feature by name

19.3Bulk options

(a)disable all features on the system

(b)upload a JSON file with features to the current system to add new features

(c)download the list of features as a JSON file from the current system to get entire information, which features are enabled and disabled

19.4Terminate all active sessions

19.5Logout

20CleanUp Routines

20.1Upload a JSON file with cleanup routines

20.2Download a JSON file with cleanup routines

20.3Reset

(a)Delete all customer cleanup routines

(b)Reset to default cleanup routines:

(i)Remove all blank lines

(ii)Delete unnecessary spaces

(iii)Remove landscape

(iv)Remove portrait

20.4Activate code edit mode:

(a)upload cleanup routines in text-format

(b)edit cleanup routines

20.5Deactivate code edit mode

20.6Delete all cleanup routines, including four default cleanup routines

21Default Settings

21.1Upload a JSON file with default settings

21.2Download a JSON file with default settings

21.3Select default PD for organization

21.4Select conversation scope "Visible for" for installation

21.5Select conversation type which should be instantiated on comment import

21.6Select default user language that will be displayed for creating a new user

21.7Select conversation field where the message will be imported

21.8Select default style for components without paragraph decorator

21.9Configure footnote text in footnote settings:

(a)colour

(b)font-family

(c)font-style

21.10Select empty line - background colour for empty not numbered, not bulleted components

22Identity

22.1Set logos for

(a)e-mails

(i)upload

(ii)download

(iii)delete

(b)first page

(i)upload

(ii)download

(iii)delete

(c)branding logo

(i)upload

(ii)download

(iii)delete

(d)Favicon

(i)upload

(ii)download

(iii)delete

(e)background image for login page

(i)upload

(ii)download

(iii)delete

(f)document list icon

(i)upload

(ii)download

(iii)delete

22.2Set text for login page

(a)Title

(b)Subtitle

(c)Edit title

(d)Edit subtitle

(e)Reset title

(f)Reset subtitle

22.3Set colour schema

(a)Header colours

(i)Background colour

(ii)Text colour

(iii)Save

(iv)Reset

(b)System colours

(i)Primary colour

(ii)Success colour

(iii)Error colour

(iv)Danger colour

(v)Save

(vi)Reset

(c)Login page colours

(i)Background colour

(ii)Text colour

(iii)Save

(iv)Reset

23URLs

23.1Upload a JSON file with URLs

23.2Download a JSON file with URLs

23.3Search URL by name

23.4Edit URL

23.5Clear URL

24Documents

24.1Search document by document name or creator

24.2See the list of created documents

(a)Name

(b)Creator

(c)Last update

(d)Date of final deletion

(e)Deleted by

(f)Other

24.3Delete a document completely

25Users

25.1Set user limit

(a)Internal/external user limit (on/off)

(b)If turned on:

(i)Set external user limit

(ii)Set internal user limit

(c)If turned off:

(i)Set all user limit

25.2Add internal user domains

25.3See the total amount of users

25.4See the total amount of selected users

25.5See the list of users in the following groups:

(a)Pending invitations

(b)Internals

(c)Externals

(d)Active

(e)De-activated

(f)System admins

25.6Select one group

25.7Select several groups

(a)Display users who belong to all selected groups

25.8Create a new user

(a)Metadata

(i)First name

(ii)Last name

(iii)Company (optionally)

(iv)Position (optionally)

(v)Email

(vi)Default language

(vii)System admin

(1)Yes

(2)No

(viii)Invite now

(1)Yes

(2)No

(ix)Create one more user after completion

(1)Yes

(2)No

25.9Applicable options to users:

(a)Pending users:

(i)Set user as system admin

(ii)Delete user

(b)Invited users:

(i)Edit user

(ii)Re-send invitation

(iii)Confirm user

(iv)Set user as system admin

(v)Delete user

(c)Confirmed users:

(i)Set password

(ii)Reset password

(iii)Deactivate user

(iv)Set user as system admin

(v)Delete user

(d)Inactive users:

(i)Activate user

(ii)Set user as system admin

(iii)Delete user

25.10Search users or company

26Admin Console management for system admins

26.1If user is system admin, this user can reach the User Management tab in Admin Console from the avatar-menu in SMASHDOCs editor.

26.2Users tab

(a)Display users in the list:

(i)in the alphabetical order

(ii)starting from the user with the earliest registration date

(iii)starting from external users

(iv)starting from system administrators

(v)in the opposite order

(b)See the list of users in the following groups:

(i)Pending invitations

(ii)Internals

(iii)Externals

(iv)Active

(v)De-activated

(vi)System admins

(c)Select one group

(d)Select several groups

(i)Display users who belong to all selected groups

(e)Create a new user

(i)Metadata

(1)First name

(2)Last name

(3)Company (optionally)

(4)Position (optionally)

(5)Email

(6)Default language

(7)System admin

(A)Yes

(B)No

(8)Invite now

(A)Yes

(B)No

(9)Create one more user after completion

(A)Yes

(B)No

(f)Applicable options to users:

(i)Pending users:

(1)Set user as system admin

(2)Delete user

(ii)Invited users:

(1)Edit user

(2)Re-send invitation

(3)Confirm user

(4)Set user as system admin

(5)Delete user

(iii)Confirmed users:

(1)Set password

(2)Reset password

(3)Deactivate user

(4)Set user as system admin

(5)Delete user

(iv)Inactive users:

(1)Activate user

(2)Set user as system admin

(3)Delete user

(g)Search users or company

26.3Documents tab

(a)Search document by document name or creator

(b)See the list of created documents

(i)Name

(ii)Creator

(iii)Last update

(iv)Date of final deletion

(v)Deleted by

(vi)Other

(c)Delete document after some time

(d)Delete a document completely